Skip to content

Commit

Permalink
Rename from @eloquent/austenite to austenite
Browse files Browse the repository at this point in the history
  • Loading branch information
ezzatron committed Oct 15, 2023
1 parent 9e6fce8 commit aa9e3ba
Show file tree
Hide file tree
Showing 43 changed files with 72 additions and 72 deletions.
20 changes: 10 additions & 10 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ The format is based on [Keep a Changelog], and this project adheres to

## [v0.5.0] - 2022-12-30

[v0.5.0]: https://github.com/eloquent/austenite/releases/tag/v0.5.0
[v0.5.0]: https://github.com/ezzatron/austenite/releases/tag/v0.5.0

### Added

- Added `networkPortNumber` declarations.

## [v0.4.0] - 2022-10-29

[v0.4.0]: https://github.com/eloquent/austenite/releases/tag/v0.4.0
[v0.4.0]: https://github.com/ezzatron/austenite/releases/tag/v0.4.0

### Changed

Expand All @@ -34,7 +34,7 @@ multiple times in different execution contexts (e.g. both outside and inside

## [v0.3.0] - 2022-10-26

[v0.3.0]: https://github.com/eloquent/austenite/releases/tag/v0.3.0
[v0.3.0]: https://github.com/ezzatron/austenite/releases/tag/v0.3.0

### Added

Expand All @@ -43,15 +43,15 @@ multiple times in different execution contexts (e.g. both outside and inside

## [v0.2.5] - 2022-10-26

[v0.2.5]: https://github.com/eloquent/austenite/releases/tag/v0.2.5
[v0.2.5]: https://github.com/ezzatron/austenite/releases/tag/v0.2.5

### Fixed

- Fixed pre-publish `package.json` script.

## [v0.2.4] - 2022-10-26

[v0.2.4]: https://github.com/eloquent/austenite/releases/tag/v0.2.4
[v0.2.4]: https://github.com/ezzatron/austenite/releases/tag/v0.2.4

### Changed

Expand All @@ -62,15 +62,15 @@ multiple times in different execution contexts (e.g. both outside and inside

## [v0.2.3] - 2022-10-25

[v0.2.3]: https://github.com/eloquent/austenite/releases/tag/v0.2.3
[v0.2.3]: https://github.com/ezzatron/austenite/releases/tag/v0.2.3

### Fixed

- Removed dependency on renamed `mdast` package.

## [v0.2.2] - 2022-10-25

[v0.2.2]: https://github.com/eloquent/austenite/releases/tag/v0.2.2
[v0.2.2]: https://github.com/ezzatron/austenite/releases/tag/v0.2.2

### Fixed

Expand All @@ -79,23 +79,23 @@ multiple times in different execution contexts (e.g. both outside and inside

## [v0.2.1] - 2022-10-24

[v0.2.1]: https://github.com/eloquent/austenite/releases/tag/v0.2.1
[v0.2.1]: https://github.com/ezzatron/austenite/releases/tag/v0.2.1

### Fixed

- Fixed pre-publish `package.json` script.

## [v0.2.0] - 2022-10-24

[v0.2.0]: https://github.com/eloquent/austenite/releases/tag/v0.2.0
[v0.2.0]: https://github.com/ezzatron/austenite/releases/tag/v0.2.0

### Added

- Added CommonJS compatibility.

## [v0.1.0] - 2022-10-24

[v0.1.0]: https://github.com/eloquent/austenite/releases/tag/v0.1.0
[v0.1.0]: https://github.com/ezzatron/austenite/releases/tag/v0.1.0

### Added

Expand Down
2 changes: 1 addition & 1 deletion ENVIRONMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ equivalent.
The application may consume other undocumented environment variables; this
document only shows those variables defined using [Austenite].

[austenite]: https://github.com/eloquent/austenite
[austenite]: https://github.com/ezzatron/austenite

## Index

Expand Down
36 changes: 18 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,18 @@ _Declarative environment variables for Node.js._
[![Build status][badge-build-image]][badge-build-link]
[![Test coverage][badge-coverage-image]][badge-coverage-link]

[badge-build-image]: https://img.shields.io/github/actions/workflow/status/eloquent/austenite/ci.yml?branch=main&style=for-the-badge
[badge-build-link]: https://github.com/eloquent/austenite/actions/workflows/ci.yml
[badge-coverage-image]: https://img.shields.io/codecov/c/gh/eloquent/austenite?style=for-the-badge
[badge-coverage-link]: https://codecov.io/gh/eloquent/austenite
[badge-version-image]: https://img.shields.io/npm/v/@eloquent/austenite?label=%40eloquent%2Faustenite&logo=npm&style=for-the-badge
[badge-version-link]: https://npmjs.com/package/@eloquent/austenite
[badge-build-image]: https://img.shields.io/github/actions/workflow/status/ezzatron/austenite/ci.yml?branch=main&style=for-the-badge
[badge-build-link]: https://github.com/ezzatron/austenite/actions/workflows/ci.yml
[badge-coverage-image]: https://img.shields.io/codecov/c/gh/austenite?style=for-the-badge
[badge-coverage-link]: https://codecov.io/gh/ezzatron/austenite
[badge-version-image]: https://img.shields.io/npm/v/austenite?label=austenite&logo=npm&style=for-the-badge
[badge-version-link]: https://npmjs.com/package/austenite

## Usage

```ts
// env.ts - declares everything needed from the environment
import { boolean, url } from "@eloquent/austenite";
import { boolean, url } from "austenite";

export const cdnUrl = url("CDN_URL", "CDN to use when serving static assets");
export const isDebug = boolean(
Expand All @@ -29,7 +29,7 @@ export const isDebug = boolean(

```ts
// run.ts - starts the service/app, uses declarations from above
import { initialize } from "@eloquent/austenite";
import { initialize } from "austenite";
import { cdnUrl, isDebug } from "./env.ts";

initialize(); // validates the environment
Expand Down Expand Up @@ -75,7 +75,7 @@ consumed by each declaration.
### `bigInteger`

```ts
import { bigInteger } from "@eloquent/austenite";
import { bigInteger } from "austenite";

// required
export const earthAtomCount = bigInteger(
Expand All @@ -101,7 +101,7 @@ export const earthAtomCount = bigInteger(
### `boolean`

```ts
import { boolean } from "@eloquent/austenite";
import { boolean } from "austenite";

// required
export const isDebug = boolean("DEBUG", "enable or disable debugging features");
Expand Down Expand Up @@ -138,8 +138,8 @@ export const isDebug = boolean(
### `duration`

```ts
import { duration } from "@eloquent/austenite";
import { Temporal } from "@js-temporal/polyfill";
import { duration } from "austenite";

// required
export const grpcTimeout = duration("GRPC_TIMEOUT", "gRPC request timeout");
Expand All @@ -158,7 +158,7 @@ export const grpcTimeout = duration("GRPC_TIMEOUT", "gRPC request timeout", {
### `enumeration`

```ts
import { enumeration } from "@eloquent/austenite";
import { enumeration } from "austenite";

const members = {
debug: { value: "debug", description: "show information for developers" },
Expand Down Expand Up @@ -201,7 +201,7 @@ export const logLevel = enumeration(
### `integer`

```ts
import { integer } from "@eloquent/austenite";
import { integer } from "austenite";

// required
export const weight = integer("WEIGHT", "weighting for this node");
Expand All @@ -220,7 +220,7 @@ export const weight = integer("WEIGHT", "weighting for this node", {
### `kubernetesAddress`

```ts
import { kubernetesAddress } from "@eloquent/austenite";
import { kubernetesAddress } from "austenite";

// required
export const redisPrimary = kubernetesAddress("redis-primary");
Expand All @@ -242,7 +242,7 @@ export const redisPrimary = kubernetesAddress("redis-primary", {
### `networkPortNumber`

```ts
import { networkPortNumber } from "@eloquent/austenite";
import { networkPortNumber } from "austenite";

// required
export const port = networkPortNumber(
Expand Down Expand Up @@ -272,7 +272,7 @@ export const port = networkPortNumber(
### `number`

```ts
import { number } from "@eloquent/austenite";
import { number } from "austenite";

// required
export const sampleRatio = number(
Expand All @@ -298,7 +298,7 @@ export const sampleRatio = number(
### `string`

```ts
import { string } from "@eloquent/austenite";
import { string } from "austenite";

// required
export const readDsn = string(
Expand All @@ -324,7 +324,7 @@ export const readDsn = string(
### `url`

```ts
import { url } from "@eloquent/austenite";
import { url } from "austenite";

// required
export const cdnUrl = url("CDN_URL", "CDN to use when serving static assets");
Expand Down
8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "@eloquent/austenite",
"name": "austenite",
"version": "0.0.0",
"description": "Declarative environment variables for Node.js.",
"keywords": [
Expand All @@ -12,9 +12,9 @@
"strict",
"static"
],
"repository": "eloquent/austenite",
"bugs": "https://github.com/eloquent/austenite/issues",
"homepage": "https://github.com/eloquent/austenite",
"repository": "ezzatron/austenite",
"bugs": "https://github.com/ezzatron/austenite/issues",
"homepage": "https://github.com/ezzatron/austenite",
"author": "Erin Millard <[email protected]>",
"license": "MIT",
"publishConfig": {
Expand Down
2 changes: 1 addition & 1 deletion src/specification.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ ${middleParagraph}
The application may consume other undocumented environment variables; this
document only shows those variables defined using [Austenite].
[austenite]: https://github.com/eloquent/austenite`;
[austenite]: https://github.com/ezzatron/austenite`;
}

function index(variables: Variable<unknown>[]): string {
Expand Down
2 changes: 1 addition & 1 deletion test/fixture/specification/app-env-var.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ This document describes the environment variables used by `<custom app name>`.
The application may consume other undocumented environment variables; this
document only shows those variables defined using [Austenite].

[austenite]: https://github.com/eloquent/austenite
[austenite]: https://github.com/ezzatron/austenite
2 changes: 1 addition & 1 deletion test/fixture/specification/big-integer/default.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ equivalent.
The application may consume other undocumented environment variables; this
document only shows those variables defined using [Austenite].

[austenite]: https://github.com/eloquent/austenite
[austenite]: https://github.com/ezzatron/austenite

## Index

Expand Down
2 changes: 1 addition & 1 deletion test/fixture/specification/big-integer/optional.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ equivalent.
The application may consume other undocumented environment variables; this
document only shows those variables defined using [Austenite].

[austenite]: https://github.com/eloquent/austenite
[austenite]: https://github.com/ezzatron/austenite

## Index

Expand Down
2 changes: 1 addition & 1 deletion test/fixture/specification/big-integer/required.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ equivalent.
The application may consume other undocumented environment variables; this
document only shows those variables defined using [Austenite].

[austenite]: https://github.com/eloquent/austenite
[austenite]: https://github.com/ezzatron/austenite

## Index

Expand Down
2 changes: 1 addition & 1 deletion test/fixture/specification/boolean/custom-literals.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ equivalent.
The application may consume other undocumented environment variables; this
document only shows those variables defined using [Austenite].

[austenite]: https://github.com/eloquent/austenite
[austenite]: https://github.com/ezzatron/austenite

## Index

Expand Down
2 changes: 1 addition & 1 deletion test/fixture/specification/boolean/default.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ equivalent.
The application may consume other undocumented environment variables; this
document only shows those variables defined using [Austenite].

[austenite]: https://github.com/eloquent/austenite
[austenite]: https://github.com/ezzatron/austenite

## Index

Expand Down
2 changes: 1 addition & 1 deletion test/fixture/specification/boolean/optional.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ equivalent.
The application may consume other undocumented environment variables; this
document only shows those variables defined using [Austenite].

[austenite]: https://github.com/eloquent/austenite
[austenite]: https://github.com/ezzatron/austenite

## Index

Expand Down
2 changes: 1 addition & 1 deletion test/fixture/specification/boolean/required.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ equivalent.
The application may consume other undocumented environment variables; this
document only shows those variables defined using [Austenite].

[austenite]: https://github.com/eloquent/austenite
[austenite]: https://github.com/ezzatron/austenite

## Index

Expand Down
2 changes: 1 addition & 1 deletion test/fixture/specification/duration/default.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ equivalent.
The application may consume other undocumented environment variables; this
document only shows those variables defined using [Austenite].

[austenite]: https://github.com/eloquent/austenite
[austenite]: https://github.com/ezzatron/austenite

## Index

Expand Down
2 changes: 1 addition & 1 deletion test/fixture/specification/duration/optional.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ equivalent.
The application may consume other undocumented environment variables; this
document only shows those variables defined using [Austenite].

[austenite]: https://github.com/eloquent/austenite
[austenite]: https://github.com/ezzatron/austenite

## Index

Expand Down
2 changes: 1 addition & 1 deletion test/fixture/specification/duration/required.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ equivalent.
The application may consume other undocumented environment variables; this
document only shows those variables defined using [Austenite].

[austenite]: https://github.com/eloquent/austenite
[austenite]: https://github.com/ezzatron/austenite

## Index

Expand Down
2 changes: 1 addition & 1 deletion test/fixture/specification/empty.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ This document describes the environment variables used by `<app>`.
The application may consume other undocumented environment variables; this
document only shows those variables defined using [Austenite].

[austenite]: https://github.com/eloquent/austenite
[austenite]: https://github.com/ezzatron/austenite
2 changes: 1 addition & 1 deletion test/fixture/specification/enumeration/default.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ equivalent.
The application may consume other undocumented environment variables; this
document only shows those variables defined using [Austenite].

[austenite]: https://github.com/eloquent/austenite
[austenite]: https://github.com/ezzatron/austenite

## Index

Expand Down
2 changes: 1 addition & 1 deletion test/fixture/specification/enumeration/optional.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ equivalent.
The application may consume other undocumented environment variables; this
document only shows those variables defined using [Austenite].

[austenite]: https://github.com/eloquent/austenite
[austenite]: https://github.com/ezzatron/austenite

## Index

Expand Down
2 changes: 1 addition & 1 deletion test/fixture/specification/enumeration/required.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ equivalent.
The application may consume other undocumented environment variables; this
document only shows those variables defined using [Austenite].

[austenite]: https://github.com/eloquent/austenite
[austenite]: https://github.com/ezzatron/austenite

## Index

Expand Down
2 changes: 1 addition & 1 deletion test/fixture/specification/integer/default.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ equivalent.
The application may consume other undocumented environment variables; this
document only shows those variables defined using [Austenite].

[austenite]: https://github.com/eloquent/austenite
[austenite]: https://github.com/ezzatron/austenite

## Index

Expand Down
Loading

0 comments on commit aa9e3ba

Please sign in to comment.