npmrc-replace-env - npm Package Compare versions

Comparing version 1.0.3 to 1.1.0

dist/cli.js

@@ -26,23 +26,20 @@ #!/usr/bin/env node
 
+// src/cli.ts
+var import_yargs = __toESM(require("yargs"));
+
 // src/index.ts
 var import_dotenv_flow = __toESM(require("dotenv-flow"));
-var file = __toESM(require("fs"));
-import_dotenv_flow.default.config();
+
+// src/utils/write-npmrc.util.ts
+var file2 = __toESM(require("fs"));
+
+// src/constants/defaults.const.ts
 var DEFAULT_NPMRC_FILE = ".npmrc";
 var DEFAULT_CONFIG_FILE = ".npmrc.config";
-function readConfig() {
-  try {
-    return file.readFileSync(DEFAULT_CONFIG_FILE).toString();
-  } catch (err) {
-    throw new Error(
-      `Config file not found: ${DEFAULT_CONFIG_FILE}. Please create a file named ${DEFAULT_CONFIG_FILE}`
-    );
-  }
-}
-function getEnvKeysFromConfig(config) {
-  return Array.from(new Set(config.match(/NPMRC_[A-Z_]+/g) || []));
-}
+var DEFAULT_ENV_PREFIX = "NPMRC_";
+
+// src/utils/get-env-value.util.ts
 function getEnvValue(env) {
   const value = process.env[env];
-  if (!value) {
+  if (typeof value !== "string" || !value) {
     throw new Error(
@@ -54,2 +51,4 @@ `Environment variable ${env} is not defined. Please define it in your .env file or pass it as an environment variable.`
 }
+
+// src/utils/generate-npmrc.util.ts
 function generateNpmrc(config, envs) {
@@ -62,5 +61,33 @@ let npmrc = config;
 }
-function writeNpmrc() {
-  const config = readConfig();
-  const envs = getEnvKeysFromConfig(config);
+
+// src/utils/get-env-from-config.util.ts
+function getEnvKeysFromConfig(config, envPrefix = "") {
+  return Array.from(
+    new Set(
+      config.match(new RegExp(`(?<=\\=)${envPrefix}[A-Z0-9_]+`, "g")) || []
+    )
+  );
+}
+
+// src/utils/read-config.util.ts
+var file = __toESM(require("fs"));
+function readConfig(configFilePath) {
+  try {
+    return file.readFileSync(configFilePath).toString();
+  } catch (err) {
+    throw new Error(
+      `Config file not found: ${configFilePath}. Please create a file named ${configFilePath}`
+    );
+  }
+}
+
+// src/utils/transform-env-prefix.util.ts
+function transformEnvPrefix(envPrefix) {
+  return envPrefix === null ? "" : envPrefix || DEFAULT_ENV_PREFIX;
+}
+
+// src/utils/write-npmrc.util.ts
+function writeNpmrc({ envPrefix }) {
+  const config = readConfig(DEFAULT_CONFIG_FILE);
+  const envs = getEnvKeysFromConfig(config, transformEnvPrefix(envPrefix));
   const npmrc = generateNpmrc(config, envs);
@@ -71,6 +98,6 @@ const lastModified = `# last modified: ${(/* @__PURE__ */ new Date()).toISOString()}
   try {
-    file.writeFileSync(DEFAULT_NPMRC_FILE, lastModified + npmrc);
+    file2.writeFileSync(DEFAULT_NPMRC_FILE, lastModified + npmrc);
   } catch (error) {
     throw new Error(
-      `Error writing to .npmrc file: ${error.message ?? error}`
+      `Error writing to ${DEFAULT_NPMRC_FILE} file: ${error.message ?? error}`
     );
@@ -80,3 +107,19 @@ }
 
+// src/index.ts
+import_dotenv_flow.default.config();
+
 // src/cli.ts
-writeNpmrc();
+var args = (0, import_yargs.default)(process.argv.slice(2)).option("prefix", {
+  alias: "p",
+  description: "Custom environment variable prefix",
+  string: true,
+  default: DEFAULT_ENV_PREFIX
+}).option("without-prefix", {
+  alias: "w",
+  description: "Do not use any prefix for environment variables",
+  boolean: true,
+  default: false
+}).help().alias("help", "h").parseSync();
+writeNpmrc({
+  envPrefix: args.withoutPrefix ? null : args.prefix
+});

dist/index.d.ts

@@ -1,3 +0,19 @@
-declare function writeNpmrc(): void;
+/**
+ * Options for writing the .npmrc file.
+ */
+interface WriteNpmrcOptions {
+    /**
+     * The prefix to be used for environment variables in the .npmrc file.
+     */
+    envPrefix?: string | null;
+}
+/**
+ * Writes the npmrc file with the specified environment prefix.
+ *
+ * @param {WriteNpmrcOptions} options - The options for writing the npmrc file.
+ * @returns {void}
+ * @throws {Error} If there is an error writing to the npmrc file.
+ */
+declare function writeNpmrc({ envPrefix }: WriteNpmrcOptions): void;
 
-export { writeNpmrc };
+export { type WriteNpmrcOptions, writeNpmrc };

dist/index.js

@@ -37,21 +37,15 @@ "use strict";
 var import_dotenv_flow = __toESM(require("dotenv-flow"));
-var file = __toESM(require("fs"));
-import_dotenv_flow.default.config();
+
+// src/utils/write-npmrc.util.ts
+var file2 = __toESM(require("fs"));
+
+// src/constants/defaults.const.ts
 var DEFAULT_NPMRC_FILE = ".npmrc";
 var DEFAULT_CONFIG_FILE = ".npmrc.config";
-function readConfig() {
-  try {
-    return file.readFileSync(DEFAULT_CONFIG_FILE).toString();
-  } catch (err) {
-    throw new Error(
-      `Config file not found: ${DEFAULT_CONFIG_FILE}. Please create a file named ${DEFAULT_CONFIG_FILE}`
-    );
-  }
-}
-function getEnvKeysFromConfig(config) {
-  return Array.from(new Set(config.match(/NPMRC_[A-Z_]+/g) || []));
-}
+var DEFAULT_ENV_PREFIX = "NPMRC_";
+
+// src/utils/get-env-value.util.ts
 function getEnvValue(env) {
   const value = process.env[env];
-  if (!value) {
+  if (typeof value !== "string" || !value) {
     throw new Error(
@@ -63,2 +57,4 @@ `Environment variable ${env} is not defined. Please define it in your .env file or pass it as an environment variable.`
 }
+
+// src/utils/generate-npmrc.util.ts
 function generateNpmrc(config, envs) {
@@ -71,5 +67,33 @@ let npmrc = config;
 }
-function writeNpmrc() {
-  const config = readConfig();
-  const envs = getEnvKeysFromConfig(config);
+
+// src/utils/get-env-from-config.util.ts
+function getEnvKeysFromConfig(config, envPrefix = "") {
+  return Array.from(
+    new Set(
+      config.match(new RegExp(`(?<=\\=)${envPrefix}[A-Z0-9_]+`, "g")) || []
+    )
+  );
+}
+
+// src/utils/read-config.util.ts
+var file = __toESM(require("fs"));
+function readConfig(configFilePath) {
+  try {
+    return file.readFileSync(configFilePath).toString();
+  } catch (err) {
+    throw new Error(
+      `Config file not found: ${configFilePath}. Please create a file named ${configFilePath}`
+    );
+  }
+}
+
+// src/utils/transform-env-prefix.util.ts
+function transformEnvPrefix(envPrefix) {
+  return envPrefix === null ? "" : envPrefix || DEFAULT_ENV_PREFIX;
+}
+
+// src/utils/write-npmrc.util.ts
+function writeNpmrc({ envPrefix }) {
+  const config = readConfig(DEFAULT_CONFIG_FILE);
+  const envs = getEnvKeysFromConfig(config, transformEnvPrefix(envPrefix));
   const npmrc = generateNpmrc(config, envs);
@@ -80,9 +104,12 @@ const lastModified = `# last modified: ${(/* @__PURE__ */ new Date()).toISOString()}
   try {
-    file.writeFileSync(DEFAULT_NPMRC_FILE, lastModified + npmrc);
+    file2.writeFileSync(DEFAULT_NPMRC_FILE, lastModified + npmrc);
   } catch (error) {
     throw new Error(
-      `Error writing to .npmrc file: ${error.message ?? error}`
+      `Error writing to ${DEFAULT_NPMRC_FILE} file: ${error.message ?? error}`
     );
   }
 }
+
+// src/index.ts
+import_dotenv_flow.default.config();
 // Annotate the CommonJS export names for ESM import in node:
@@ -89,0 +116,0 @@ 0 && (module.exports = {

package.json

 {
   "name": "npmrc-replace-env",
-  "version": "1.0.3",
+  "version": "1.1.0",
   "description": "A utility for generating .npmrc files based on configuration template and environment variables.",
@@ -11,9 +11,14 @@ "license": "MIT",
   "dependencies": {
-    "dotenv-flow": "^4.1.0"
+    "dotenv-flow": "^4.1.0",
+    "yargs": "^17.7.2"
   },
   "devDependencies": {
     "@changesets/cli": "^2.27.1",
-    "@types/node": "^20.11.19",
+    "@types/jest": "^29.5.12",
+    "@types/node": "^20.11.27",
+    "@types/yargs": "^17.0.32",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.1.2",
     "tsup": "^8.0.2",
-    "typescript": "^5.3.3"
+    "typescript": "^5.4.2"
   },
@@ -50,4 +55,5 @@ "files": [
     "release": "pnpm run build && changeset publish",
+    "test": "jest",
     "lint": "tsc"
   }
 }

README.md

@@ -28,3 +28,4 @@ # npmrc-replace-env
 
-**Note**: While installing the package is an option, it's important to highlight that it is not required for using the utility. The utility can be directly invoked using npx without installing the package.
+[!NOTE]
+While installing the package is an option, it's important to note that it's not required to use the utility. The utility can be invoked directly with npx without installing the package.
 
@@ -83,2 +84,16 @@ ## Usage
 
+## Command Line Options
+
+The utility supports the following command-line options for customization:
+
+| Option          | Alias | Description                                    | Default              |
+|-----------------|-------|------------------------------------------------|----------------------|
+| `--prefix`      | `-p`  | Custom environment variable prefix             | `NPMRC_`|
+| `--without-prefix`| `-w`| Do not use any prefix for environment variables| `false`              |
+
+These options provide flexibility in configuring environment variables and allow tailoring the utility to your specific needs.
+
+[!NOTE]
+To display the help message for command-line options, use the `--help` or `-h` option when invoking the utility:
+
 ## Contributing
@@ -85,0 +100,0 @@

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

19001

34.43%

Lines of code

326

44.89%

Number of lines in readme file

105

16.67%

Worsened metrics

Dependency count

2

100%

Dev dependency count

8

100%

Number of low supply chain risk alerts

9

50%

Number of medium supply chain risk alerts

1

Infinity%

Dependency changes

• + Added

  yargs@^17.7.2

• + Added

  ansi-regex@5.0.1
  (transitive)

• + Added

  ansi-styles@4.3.0
  (transitive)

• + Added

  cliui@8.0.1
  (transitive)

• + Added

  color-convert@2.0.1
  (transitive)

• + Added

  color-name@1.1.4
  (transitive)

• + Added

  emoji-regex@8.0.0
  (transitive)

• + Added

  escalade@3.2.0
  (transitive)

• + Added

  get-caller-file@2.0.5
  (transitive)

• + Added

  is-fullwidth-code-point@3.0.0
  (transitive)

• + Added

  require-directory@2.1.1
  (transitive)

• + Added

  string-width@4.2.3
  (transitive)

• + Added

  strip-ansi@6.0.1
  (transitive)

• + Added

  wrap-ansi@7.0.0
  (transitive)

• + Added

  y18n@5.0.8
  (transitive)

• + Added

  yargs@17.7.2
  (transitive)

• + Added

  yargs-parser@21.1.1
  (transitive)