Skip to content

Commit 2369a0a

Browse files
author
Ernest
committed
feat: prepare
1 parent 07ff266 commit 2369a0a

20 files changed

+369
-17
lines changed

‎.github/workflows/ci.yml

+1
Original file line numberDiff line numberDiff line change
@@ -295,6 +295,7 @@ jobs:
295295
- babel
296296
- cli
297297
- flow
298+
- prepare
298299
- swc
299300
- typescript
300301
- unplugin

‎.github/workflows/release.yml

+1
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ jobs:
1616
- babel
1717
- cli
1818
- flow
19+
- prepare
1920
- swc
2021
- typescript
2122
- unplugin

‎docs/.api/.gitignore

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1 @@
1-
cli.md
2-
flow.md
3-
typescript.md
1+
*

‎docs/.api/babel.md

-3
This file was deleted.

‎docs/.api/swc.md

-3
This file was deleted.

‎docs/.api/unplugin.md

-3
This file was deleted.

‎docs/.vitepress/.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
cache

‎docs/guide/tools/prepare.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Prepare
2+
3+
Generate `.env` file from `.env.*` files.
4+
5+
## Installation
6+
7+
[![NPM version](https://img.shields.io/npm/v/@import-meta-env/prepare.svg?color=blue)](https://www.npmjs.com/package/@import-meta-env/prepare)
8+
9+
```bash
10+
$ npm i -D @import-meta-env/prepare
11+
```
12+
13+
## Usage
14+
15+
```bash
16+
$ npx import-meta-env-prepare -x .env.example
17+
```
18+
19+
By default, when running above command, the CLI will load environment variables from `.env.local.defaults` and `.env.local`, merge both, then create an `.env` file in your project root:
20+
21+
```ini
22+
# .env
23+
# Generated by '@import-meta-env/prepare'
24+
25+
NAME=world
26+
```

‎packages/prepare/LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2023 Ernest
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎packages/prepare/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# @import-meta-env/prepare
2+
3+
[Documentation](https://iendeavor.github.io/import-meta-env/)

‎packages/prepare/babel.config.js

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
module.exports = require("../../babel.config");

‎packages/prepare/package.json

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
{
2+
"name": "@import-meta-env/prepare",
3+
"version": "0.1.0",
4+
"description": "Build once, deploy anywhere. Startup/runtime environment variable solution for JavaScript.",
5+
"license": "MIT",
6+
"author": "Ernest",
7+
"keywords": [
8+
"twelve-factor",
9+
"dotenv"
10+
],
11+
"bin": {
12+
"import-meta-env-prepare": "bin/import-meta-env-prepare.js"
13+
},
14+
"files": [
15+
"bin"
16+
],
17+
"scripts": {
18+
"build": "rimraf bin && pnpm build-prepare",
19+
"build-prepare": "esbuild src/index.ts --bundle --platform=node --target=node14 --external:dotenv --outfile=bin/import-meta-env-prepare.js && node ./scripts/patchBin.js",
20+
"pack": "rm -f *.tgz && pnpm pack && node ../../scripts/rename-tgz.js",
21+
"release": "standard-version --skip.tag -t prepare --preset=conventionalcommits --releaseCommitMessageFormat 'chore(release): @import-meta-env/prepare@{{currentTag}}' --path .",
22+
"test": "jest src/__tests__"
23+
},
24+
"engines": {
25+
"node": ">= 14"
26+
},
27+
"repository": {
28+
"type": "git",
29+
"url": "git+https://github.com/iendeavor/import-meta-env.git",
30+
"directory": "packages/prepare"
31+
},
32+
"bugs": {
33+
"url": "https://github.com/iendeavor/import-meta-env/issues"
34+
},
35+
"homepage": "https://github.com/iendeavor/import-meta-env/tree/main/packages/prepare#readme",
36+
"devDependencies": {
37+
"@types/glob": "8.0.0",
38+
"@types/serialize-javascript": "5.0.2"
39+
},
40+
"peerDependencies": {
41+
"dotenv": "^11.0.0 || ^12.0.4 || ^13.0.1 || ^14.3.2 || ^15.0.1 || ^16.0.0"
42+
},
43+
"dependencies": {
44+
"commander": "10.0.0",
45+
"glob": "8.1.0",
46+
"picocolors": "1.0.0",
47+
"serialize-javascript": "6.0.1"
48+
}
49+
}

‎packages/prepare/scripts/patchBin.js

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
const { readFileSync, writeFileSync } = require("fs");
2+
3+
const filePath = "bin/import-meta-env-prepare.js";
4+
5+
const oldContent = readFileSync(filePath, "utf-8");
6+
const newContent = `#!/usr/bin/env node\n'use strict';\n${oldContent}`;
7+
writeFileSync(filePath, newContent);

‎packages/prepare/src/__tests__/index.test.ts

+129
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
import fs from "fs";
2+
import tmp from "tmp";
3+
import { Args } from "../create-command";
4+
import { main } from "../index";
5+
6+
beforeEach(() => {
7+
const wd = tmp.dirSync();
8+
process.chdir(wd.name);
9+
delete process.env.FOO;
10+
});
11+
12+
describe("integration", () => {
13+
test("default", () => {
14+
const env = ".env";
15+
const example = ".env.example";
16+
const defaults = ".env.local.default";
17+
const local = ".env.local";
18+
const userEnvironment = false;
19+
fs.writeFileSync(example, "FOO=\nBAR=\n");
20+
fs.writeFileSync(defaults, "FOO=foo\nBAR=bar\nBAZ=baz\n");
21+
fs.writeFileSync(local, "FOO=local\nBAZ=local\n");
22+
process.env.BAR = "user-environment";
23+
const args: Args = {
24+
env,
25+
example,
26+
path: [defaults, local],
27+
userEnvironment,
28+
};
29+
30+
main(args);
31+
32+
expect(fs.readFileSync(env, "utf8")).toEqual(
33+
"# Generated by '@import-meta-env/prepare'\n\nBAR=bar\nFOO=local\n"
34+
);
35+
});
36+
37+
test("--env", () => {
38+
const env = ".env" + Math.random().toString(36);
39+
const example = ".env.example";
40+
const defaults = ".env.local.default";
41+
const local = ".env.local";
42+
const userEnvironment = false;
43+
fs.writeFileSync(example, "FOO=\nBAR=\n");
44+
fs.writeFileSync(defaults, "FOO=foo\nBAR=bar\nBAZ=baz\n");
45+
fs.writeFileSync(local, "FOO=local\nBAZ=local\n");
46+
const args: Args = {
47+
env,
48+
example,
49+
path: [defaults, local],
50+
userEnvironment,
51+
};
52+
53+
main(args);
54+
55+
expect(fs.readFileSync(env, "utf8")).toEqual(
56+
"# Generated by '@import-meta-env/prepare'\n\nBAR=bar\nFOO=local\n"
57+
);
58+
});
59+
60+
test("--example", () => {
61+
const env = ".env";
62+
const example = ".env.example" + Math.random().toString(36);
63+
const defaults = ".env.local.default";
64+
const local = ".env.local";
65+
const userEnvironment = false;
66+
fs.writeFileSync(example, "FOO=\nBAR=\n");
67+
fs.writeFileSync(defaults, "FOO=foo\nBAR=bar\nBAZ=baz\n");
68+
fs.writeFileSync(local, "FOO=local\nBAZ=local\n");
69+
const args: Args = {
70+
env,
71+
example,
72+
path: [defaults, local],
73+
userEnvironment,
74+
};
75+
76+
main(args);
77+
78+
expect(fs.readFileSync(env, "utf8")).toEqual(
79+
"# Generated by '@import-meta-env/prepare'\n\nBAR=bar\nFOO=local\n"
80+
);
81+
});
82+
83+
test("--path", () => {
84+
const env = ".env";
85+
const example = ".env.example";
86+
const defaults = ".env.local.default" + Math.random().toString(36);
87+
const local = ".env.local" + Math.random().toString(36);
88+
const userEnvironment = false;
89+
fs.writeFileSync(example, "FOO=\nBAR=\n");
90+
fs.writeFileSync(defaults, "FOO=foo\nBAR=bar\nBAZ=baz\n");
91+
fs.writeFileSync(local, "FOO=local\nBAZ=local\n");
92+
const args: Args = {
93+
env,
94+
example,
95+
path: [defaults, local],
96+
userEnvironment,
97+
};
98+
99+
main(args);
100+
101+
expect(fs.readFileSync(env, "utf8")).toEqual(
102+
"# Generated by '@import-meta-env/prepare'\n\nBAR=bar\nFOO=local\n"
103+
);
104+
});
105+
106+
test("--userEnvironment", () => {
107+
const env = ".env";
108+
const example = ".env.example";
109+
const defaults = ".env.local.default";
110+
const local = ".env.local";
111+
const userEnvironment = true;
112+
fs.writeFileSync(example, "FOO=\nBAR=\n");
113+
fs.writeFileSync(defaults, "FOO=foo\nBAR=bar\nBAZ=baz\n");
114+
fs.writeFileSync(local, "FOO=local\nBAZ=local\n");
115+
process.env.BAR = "user-environment";
116+
const args: Args = {
117+
env,
118+
example,
119+
path: [defaults, local],
120+
userEnvironment,
121+
};
122+
123+
main(args);
124+
125+
expect(fs.readFileSync(env, "utf8")).toEqual(
126+
"# Generated by '@import-meta-env/prepare'\n\nBAR=user-environment\nFOO=local\n"
127+
);
128+
});
129+
});

‎packages/prepare/src/create-command.ts

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
import { Command } from "commander";
2+
import { version } from "../package.json";
3+
4+
export interface Args {
5+
env: string;
6+
example: string;
7+
path: string[];
8+
userEnvironment: boolean;
9+
}
10+
11+
export const createCommand = () =>
12+
new Command()
13+
.version(version)
14+
.description("Generate `.env` file from `.env.*` files.")
15+
.option("-e, --env <path>", ".env file path to write", ".env")
16+
.requiredOption("-x, --example <path>", ".env.example file path to read")
17+
.option("-p, --path <path...>", `.env.* file paths to read`, [
18+
".env.local.defaults",
19+
".env.local",
20+
])
21+
.option(
22+
"-u, --user-environment",
23+
"whether to load user environment variables (i.e., process.env.*)",
24+
false
25+
);

‎packages/prepare/src/index.ts

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
import { existsSync, readFileSync, writeFileSync } from "fs";
2+
import { resolve } from "path";
3+
import { parse } from "dotenv";
4+
import { Args, createCommand } from "./create-command";
5+
import { resolveEnvExampleKeys } from "../../shared/resolve-env-example-keys";
6+
7+
export const main = (args: Args) => {
8+
const envExampleKeys = resolveEnvExampleKeys({
9+
envExampleFilePath: args.example,
10+
});
11+
const env = args.path
12+
.map((p) => {
13+
p = resolve(process.cwd(), p);
14+
if (existsSync(p) === false) {
15+
writeFileSync(p, "", "utf8");
16+
}
17+
return parse(readFileSync(p, "utf8"));
18+
})
19+
.concat(
20+
args.userEnvironment
21+
? [
22+
Object.keys(process.env).reduce<Record<string, string>>(
23+
(acc, k) => Object.assign(acc, { [k]: process.env[k] }),
24+
{}
25+
),
26+
]
27+
: []
28+
)
29+
.reduce((env, partial) => Object.assign(env, partial), {});
30+
31+
const stringifiedEnv =
32+
Object.keys(env)
33+
.sort()
34+
.filter((k) => envExampleKeys.includes(k))
35+
.map((k) => `${k}=${env[k]}`)
36+
.join("\n") + "\n";
37+
38+
writeFileSync(
39+
args.env,
40+
`# Generated by '@import-meta-env/prepare'\n\n${stringifiedEnv}`,
41+
"utf8"
42+
);
43+
};
44+
45+
if (require.main === module) {
46+
const command = createCommand().parse();
47+
const args: Args = command.opts();
48+
main(args);
49+
}

‎packages/prepare/tsconfig.json

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"include": ["src"],
3+
"exclude": ["**/*.test.ts"],
4+
"extends": "../../tsconfig.json"
5+
}

0 commit comments

Comments
 (0)