refactor: Convert to conceptually private context

BREAKING CHANGE Modules in folder are no longer considerd public and are subject to changes in any release phase
medikoo · Nov 27, 2023 · 2c08940 · 2c08940
1 parent 4baa7a9
commit 2c08940
Show file tree

Hide file tree

Showing 53 changed files with 44 additions and 44 deletions.
diff --git a/install-dependencies.js b/install-dependencies.js
@@ -6,9 +6,9 @@ const toPlainObject       = require("es5-ext/object/normalize-options")
     , { resolve }         = require("path")
     , ensurePackageName   = require("./lib/ensure-package-name")
     , NpmCrossLinkError   = require("./lib/npm-cross-link-error")
-    , ensureConfiguration = require("./lib/private/ensure-user-configuration")
-    , createProgressData  = require("./lib/private/create-progress-data")
-    , installDependencies = require("./lib/private/install-dependencies")
+    , ensureConfiguration = require("./lib/ensure-user-configuration")
+    , createProgressData  = require("./lib/create-progress-data")
+    , installDependencies = require("./lib/install-dependencies")
     , getPackageJson      = require("./lib/get-package-json");
 
 module.exports = (path, dependencyNames, userConfiguration, inputOptions = {}) => {

diff --git a/install-packages-globally.js b/install-packages-globally.js
@@ -3,10 +3,10 @@
 const ensureObject             = require("es5-ext/object/valid-object")
     , toPlainObject            = require("es5-ext/object/normalize-options")
     , ensurePackageName        = require("./lib/ensure-package-name")
-    , ensureConfiguration      = require("./lib/private/ensure-user-configuration")
-    , createProgressData       = require("./lib/private/create-progress-data")
-    , installPackageGlobally   = require("./lib/private/install-package-globally")
-    , installMaintainedPackage = require("./lib/private/install-maintained-package");
+    , ensureConfiguration      = require("./lib/ensure-user-configuration")
+    , createProgressData       = require("./lib/create-progress-data")
+    , installPackageGlobally   = require("./lib/install-package-globally")
+    , installMaintainedPackage = require("./lib/install-maintained-package");
 
 module.exports = (packageNames, userConfiguration, inputOptions = {}) => {
 	packageNames = Array.from(ensureObject(packageNames), ensurePackageName);

diff --git a/install.js b/install.js
@@ -4,9 +4,9 @@ const toPlainObject         = require("es5-ext/object/normalize-options")
     , ensureString          = require("es5-ext/object/validate-stringifiable-value")
     , { resolve, basename } = require("path")
     , NpmCrossLinkError     = require("./lib/npm-cross-link-error")
-    , ensureConfiguration   = require("./lib/private/ensure-user-configuration")
-    , createProgressData    = require("./lib/private/create-progress-data")
-    , install               = require("./lib/private/install")
+    , ensureConfiguration   = require("./lib/ensure-user-configuration")
+    , createProgressData    = require("./lib/create-progress-data")
+    , install               = require("./lib/install")
     , getPackageJson        = require("./lib/get-package-json");
 
 module.exports = (path, userConfiguration, inputOptions = {}) => {

diff --git a/lib/private/cache.js → lib/cache.js b/lib/private/cache.js → lib/cache.js
diff --git a/lib/private/cleanup-npm-install.js → lib/cleanup-npm-install.js b/lib/private/cleanup-npm-install.js → lib/cleanup-npm-install.js
diff --git a/lib/cli/index.js b/lib/cli/index.js
@@ -5,7 +5,7 @@ const log                      = require("log").get("npm-cross-link")
     , format                   = require("cli-sprintf-format")
     , cliFooter                = require("cli-progress-footer")()
     , NpmCrossLinkError        = require("../npm-cross-link-error")
-    , resolveUserConfiguration = require("../private/resolve-user-configuration")
+    , resolveUserConfiguration = require("../resolve-user-configuration")
     , install                  = require("../../install")
     , installPackagesGlobally  = require("../../install-packages-globally")
     , installDependencies      = require("../../install-dependencies")

diff --git a/lib/private/create-progress-data.js → lib/create-progress-data.js b/lib/private/create-progress-data.js → lib/create-progress-data.js
diff --git a/lib/private/ensure-user-configuration.js → lib/ensure-user-configuration.js b/lib/private/ensure-user-configuration.js → lib/ensure-user-configuration.js
@@ -8,7 +8,7 @@ const ensureArray         = require("es5-ext/array/valid-array")
     , { resolve }         = require("path")
     , { homedir }         = require("os")
     , log                 = require("log").get("npm-cross-link:configuration").debug
-    , NpmCrossLinkError   = require("../npm-cross-link-error");
+    , NpmCrossLinkError   = require("./npm-cross-link-error");
 
 module.exports = userConfiguration => {
 	log.debug("user input: %O", userConfiguration);

diff --git a/...private/entries-to-ordered-keys-object.js → lib/entries-to-ordered-keys-object.js b/...private/entries-to-ordered-keys-object.js → lib/entries-to-ordered-keys-object.js
diff --git a/lib/private/get-metadata.js → lib/get-metadata.js b/lib/private/get-metadata.js → lib/get-metadata.js
diff --git a/...-dependencies/add-package-json-section.js → ...-dependencies/add-package-json-section.js b/...-dependencies/add-package-json-section.js → ...-dependencies/add-package-json-section.js
diff --git a/lib/private/install-dependencies/index.js → lib/install-dependencies/index.js b/lib/private/install-dependencies/index.js → lib/install-dependencies/index.js
diff --git a/...cies/resolve-dependencies-section-name.js → ...cies/resolve-dependencies-section-name.js b/...cies/resolve-dependencies-section-name.js → ...cies/resolve-dependencies-section-name.js
diff --git a/...te/install-maintained-package/finalize.js → lib/install-maintained-package/finalize.js b/...te/install-maintained-package/finalize.js → lib/install-maintained-package/finalize.js
diff --git a/...ivate/install-maintained-package/index.js → lib/install-maintained-package/index.js b/...ivate/install-maintained-package/index.js → lib/install-maintained-package/index.js
@@ -5,9 +5,9 @@ const optionalChaining             = require("es5-ext/optional-chaining")
     , log                          = require("log").get("npm-cross-link")
     , isDirectory                  = require("fs2/is-directory")
     , rm                           = require("fs2/rm")
-    , NpmCrossLinkError            = require("../../npm-cross-link-error")
-    , getPackageJson               = require("../../get-package-json")
-    , getNpmModulesPath            = require("../../get-npm-modules-path")
+    , NpmCrossLinkError            = require("../npm-cross-link-error")
+    , getPackageJson               = require("../get-package-json")
+    , getNpmModulesPath            = require("../get-npm-modules-path")
     , cleanupNpmInstall            = require("../cleanup-npm-install")
     , setupRepository              = require("../setup-repository")
     , resolveExternalContext       = require("../resolve-external-context")

diff --git a/...te/install-maintained-package/npm-link.js → lib/install-maintained-package/npm-link.js b/...te/install-maintained-package/npm-link.js → lib/install-maintained-package/npm-link.js
@@ -5,8 +5,8 @@ const { resolve }       = require("path")
     , isSymlink         = require("fs2/is-symlink")
     , rm                = require("fs2/rm")
     , cleanupNpmInstall = require("../cleanup-npm-install")
-    , getNpmModulesPath = require("../../get-npm-modules-path")
-    , runProgram        = require("../../run-program");
+    , getNpmModulesPath = require("../get-npm-modules-path")
+    , runProgram        = require("../run-program");
 
 module.exports = async packageContext => {
 	const { path, name, installationJobs, isNameMismatch } = packageContext;

diff --git a/lib/private/install-package-globally.js → lib/install-package-globally.js b/lib/private/install-package-globally.js → lib/install-package-globally.js
@@ -4,9 +4,9 @@ const { resolve }             = require("path")
     , log                     = require("log").get("npm-cross-link")
     , wait                    = require("timers-ext/promise/sleep")
     , rm                      = require("fs2/rm")
-    , NpmCrossLinkError       = require("../npm-cross-link-error")
-    , getNpmModulesPath       = require("../get-npm-modules-path")
-    , runProgram              = require("../run-program")
+    , NpmCrossLinkError       = require("./npm-cross-link-error")
+    , getNpmModulesPath       = require("./get-npm-modules-path")
+    , runProgram              = require("./run-program")
     , nonOverridableExternals = require("./non-overridable-externals")
     , resolveExternalContext  = require("./resolve-external-context");
 

diff --git a/lib/private/install.js → lib/install.js b/lib/private/install.js → lib/install.js
@@ -3,7 +3,7 @@
 const { basename }                  = require("path")
     , wait                          = require("timers-ext/promise/sleep")
     , cleanupNpmInstall             = require("./cleanup-npm-install")
-    , getPackageJson                = require("../get-package-json")
+    , getPackageJson                = require("./get-package-json")
     , removeNonDirectDependencies   = require("./remove-non-direct-dependencies")
     , installMaintainedPackage      = require("./install-maintained-package")
     , updatePackageJsonDependencies = require("./update-package-json-dependencies")

diff --git a/lib/private/non-overridable-externals.js → lib/non-overridable-externals.js b/lib/private/non-overridable-externals.js → lib/non-overridable-externals.js
diff --git a/...private/remove-non-direct-dependencies.js → lib/remove-non-direct-dependencies.js b/...private/remove-non-direct-dependencies.js → lib/remove-non-direct-dependencies.js
diff --git a/lib/private/resolve-dependency-context.js → lib/resolve-dependency-context.js b/lib/private/resolve-dependency-context.js → lib/resolve-dependency-context.js
diff --git a/lib/private/resolve-external-context.js → lib/resolve-external-context.js b/lib/private/resolve-external-context.js → lib/resolve-external-context.js
@@ -4,7 +4,7 @@ const optionalChaining = require("es5-ext/optional-chaining")
     , log              = require("log").get("npm-cross-link")
     , isDirectory      = require("fs2/is-directory")
     , semver           = require("semver")
-    , getPackageJson   = require("../get-package-json")
+    , getPackageJson   = require("./get-package-json")
     , getMetadata      = require("./get-metadata");
 
 const getVersions = ({ externalContext: { metadata } }) => Object.keys(metadata.versions);

diff --git a/...rivate/resolve-maintained-package-path.js → lib/resolve-maintained-package-path.js b/...rivate/resolve-maintained-package-path.js → lib/resolve-maintained-package-path.js
diff --git a/lib/private/resolve-updated-version-range.js → lib/resolve-updated-version-range.js b/lib/private/resolve-updated-version-range.js → lib/resolve-updated-version-range.js
diff --git a/lib/private/resolve-user-configuration.js → lib/resolve-user-configuration.js b/lib/private/resolve-user-configuration.js → lib/resolve-user-configuration.js
@@ -3,7 +3,7 @@
 const { resolve }           = require("path")
     , { homedir }           = require("os")
     , isModuleNotFoundError = require("ncjsm/is-module-not-found-error")
-    , NpmCrossLinkError     = require("../npm-cross-link-error");
+    , NpmCrossLinkError     = require("./npm-cross-link-error");
 
 const configurationPath = resolve(homedir(), ".npm-cross-link");
 

diff --git a/lib/private/setup-dependencies/index.js → lib/setup-dependencies/index.js b/lib/private/setup-dependencies/index.js → lib/setup-dependencies/index.js
@@ -1,7 +1,7 @@
 "use strict";
 
 const log                       = require("log").get("npm-cross-link")
-    , getPackageJson            = require("../../get-package-json")
+    , getPackageJson            = require("../get-package-json")
     , processDependency         = require("./process-dependency")
     , setupRequiredDependencies = require("./setup-required-dependencies");
 

diff --git a/.../setup-dependencies/process-dependency.js → lib/setup-dependencies/process-dependency.js b/.../setup-dependencies/process-dependency.js → lib/setup-dependencies/process-dependency.js
diff --git a/...pendencies/setup-required-dependencies.js → ...pendencies/setup-required-dependencies.js b/...pendencies/setup-required-dependencies.js → ...pendencies/setup-required-dependencies.js
diff --git a/lib/private/setup-dependency/index.js → lib/setup-dependency/index.js b/lib/private/setup-dependency/index.js → lib/setup-dependency/index.js
@@ -3,7 +3,7 @@
 const { resolve }       = require("path")
     , log               = require("log").get("npm-cross-link")
     , semver            = require("semver")
-    , getNpmModulesPath = require("../../get-npm-modules-path")
+    , getNpmModulesPath = require("../get-npm-modules-path")
     , setupExternal     = require("./setup-external")
     , setupLocal        = require("./setup-local")
     , resolveLogLevel   = require("./resolve-log-level");

diff --git a/.../install-external/binary-handler/index.js → .../install-external/binary-handler/index.js b/.../install-external/binary-handler/index.js → .../install-external/binary-handler/index.js
diff --git a/...external/binary-handler/win-templates/bin → ...external/binary-handler/win-templates/bin b/...external/binary-handler/win-templates/bin → ...external/binary-handler/win-templates/bin
diff --git a/...rnal/binary-handler/win-templates/bin.cmd → ...rnal/binary-handler/win-templates/bin.cmd b/...rnal/binary-handler/win-templates/bin.cmd → ...rnal/binary-handler/win-templates/bin.cmd
diff --git a/...rnal/binary-handler/win-templates/bin.ps1 → ...rnal/binary-handler/win-templates/bin.ps1 b/...rnal/binary-handler/win-templates/bin.ps1 → ...rnal/binary-handler/win-templates/bin.ps1
diff --git a/...etup-dependency/install-external/index.js → ...etup-dependency/install-external/index.js b/...etup-dependency/install-external/index.js → ...etup-dependency/install-external/index.js
@@ -6,7 +6,7 @@ const optionalChaining    = require("es5-ext/optional-chaining")
     , isDirectory         = require("fs2/is-directory")
     , rm                  = require("fs2/rm")
     , log                 = require("log").get("npm-cross-link")
-    , getPackageJson      = require("../../../get-package-json")
+    , getPackageJson      = require("../../get-package-json")
     , muteErrorIfOptional = require("../mute-error-if-optional")
     , prepareDependency   = require("./prepare")
     , resolveBinariesDict = require("./resolve-binaries-dict")

diff --git a/...ependency/install-external/prepare/git.js → ...ependency/install-external/prepare/git.js b/...ependency/install-external/prepare/git.js → ...ependency/install-external/prepare/git.js
@@ -4,7 +4,7 @@ const memoizee    = require("memoizee")
     , { resolve } = require("path")
     , rm          = require("fs2/rm")
     , log         = require("log").get("npm-cross-link")
-    , runProgram  = require("../../../../run-program");
+    , runProgram  = require("../../../run-program");
 
 const repoDataRe = /^git\+(?<url>[^#]+)(?:#(?<target>.*))?$/u
     , refRe = /^refs\/(?:heads|tags)\/(?<target>.+)$/u;

diff --git a/...endency/install-external/prepare/index.js → ...endency/install-external/prepare/index.js b/...endency/install-external/prepare/index.js → ...endency/install-external/prepare/index.js
@@ -10,7 +10,7 @@ const memoizee            = require("memoizee")
     , tmpdir              = require("os").tmpdir()
     , log                 = require("log").get("npm-cross-link")
     , cachePath           = require("../../../cache").path
-    , getPackageJson      = require("../../../../get-package-json")
+    , getPackageJson      = require("../../../get-package-json")
     , updatePackageJson   = require("../../../update-package-json")
     , resolveBinariesDict = require("../resolve-binaries-dict");
 

diff --git a/...endency/install-external/prepare/other.js → ...endency/install-external/prepare/other.js b/...endency/install-external/prepare/other.js → ...endency/install-external/prepare/other.js
@@ -5,7 +5,7 @@ const { resolve } = require("path")
     , rename      = require("fs2/rename")
     , rm          = require("fs2/rm")
     , log         = require("log").get("npm-cross-link")
-    , runProgram  = require("../../../../run-program");
+    , runProgram  = require("../../../run-program");
 
 module.exports = {
 	isApplicable: () => true,

diff --git a/...dency/install-external/prepare/sem-ver.js → ...dency/install-external/prepare/sem-ver.js b/...dency/install-external/prepare/sem-ver.js → ...dency/install-external/prepare/sem-ver.js
@@ -6,7 +6,7 @@ const optionalChaining    = require("es5-ext/optional-chaining")
     , writeFile           = require("fs2/write-file")
     , tar                 = require("tar")
     , log                 = require("log").get("npm-cross-link")
-    , runProgram          = require("../../../../run-program")
+    , runProgram          = require("../../../run-program")
     , resolveNpmAuthToken = require("../../resolve-npm-auth-token")
     , nodeFetch           = require("node-fetch");
 

diff --git a/...install-external/resolve-binaries-dict.js → ...install-external/resolve-binaries-dict.js b/...install-external/resolve-binaries-dict.js → ...install-external/resolve-binaries-dict.js
@@ -1,7 +1,7 @@
 "use strict";
 
 const memoizee       = require("memoizee")
-    , getPackageJson = require("../../../get-package-json");
+    , getPackageJson = require("../../get-package-json");
 
 module.exports = memoizee(
 	path => {

diff --git a/...etup-dependency/mute-error-if-optional.js → ...etup-dependency/mute-error-if-optional.js b/...etup-dependency/mute-error-if-optional.js → ...etup-dependency/mute-error-if-optional.js
diff --git a/...ate/setup-dependency/resolve-log-level.js → lib/setup-dependency/resolve-log-level.js b/...ate/setup-dependency/resolve-log-level.js → lib/setup-dependency/resolve-log-level.js
diff --git a/...etup-dependency/resolve-npm-auth-token.js → ...etup-dependency/resolve-npm-auth-token.js b/...etup-dependency/resolve-npm-auth-token.js → ...etup-dependency/resolve-npm-auth-token.js
diff --git a/.../setup-dependency/setup-external/index.js → lib/setup-dependency/setup-external/index.js b/.../setup-dependency/setup-external/index.js → lib/setup-dependency/setup-external/index.js
@@ -3,8 +3,8 @@
 const log                 = require("log").get("npm-cross-link")
     , isSymlink           = require("fs2/is-symlink")
     , rm                  = require("fs2/rm")
-    , NpmCrossLinkError   = require("../../../npm-cross-link-error")
-    , runProgram          = require("../../../run-program")
+    , NpmCrossLinkError   = require("../../npm-cross-link-error")
+    , runProgram          = require("../../run-program")
     , installExternal     = require("../install-external")
     , muteErrorIfOptional = require("../mute-error-if-optional")
     , resolveIsToBeLinked = require("./resolve-is-to-be-linked");

diff --git a/...setup-external/resolve-is-to-be-linked.js → ...setup-external/resolve-is-to-be-linked.js b/...setup-external/resolve-is-to-be-linked.js → ...setup-external/resolve-is-to-be-linked.js
diff --git a/...p-dependency/setup-local/generate-link.js → ...p-dependency/setup-local/generate-link.js b/...p-dependency/setup-local/generate-link.js → ...p-dependency/setup-local/generate-link.js
@@ -2,7 +2,7 @@
 
 const rm         = require("fs2/rm")
     , log        = require("log").get("npm-cross-link")
-    , runProgram = require("../../../run-program");
+    , runProgram = require("../../run-program");
 
 module.exports = async dependencyContext => {
 	const { dependentContext, name, path } = dependencyContext;

diff --git a/...ate/setup-dependency/setup-local/index.js → lib/setup-dependency/setup-local/index.js b/...ate/setup-dependency/setup-local/index.js → lib/setup-dependency/setup-local/index.js
diff --git a/...ency/setup-local/resolve-local-context.js → ...ency/setup-local/resolve-local-context.js b/...ency/setup-local/resolve-local-context.js → ...ency/setup-local/resolve-local-context.js
@@ -2,7 +2,7 @@
 
 const optionalChaining             = require("es5-ext/optional-chaining")
     , log                          = require("log").get("npm-cross-link")
-    , getPackageJson               = require("../../../get-package-json")
+    , getPackageJson               = require("../../get-package-json")
     , resolveMaintainedPackagePath = require("../../resolve-maintained-package-path");
 
 module.exports = (dependencyContext, userConfiguration, { locals }) => {

diff --git a/lib/private/setup-repository.js → lib/setup-repository.js b/lib/private/setup-repository.js → lib/setup-repository.js
@@ -5,7 +5,7 @@ const memoizee    = require("memoizee")
     , log         = require("log").get("npm-cross-link")
     , isDirectory = require("fs2/is-directory")
     , rm          = require("fs2/rm")
-    , runProgram  = require("../run-program");
+    , runProgram  = require("./run-program");
 
 const resolveCurrentBranch = async path =>
 	String(

diff --git a/lib/private/update-all.js → lib/update-all.js b/lib/private/update-all.js → lib/update-all.js
diff --git a/...ivate/update-package-json-dependencies.js → lib/update-package-json-dependencies.js b/...ivate/update-package-json-dependencies.js → lib/update-package-json-dependencies.js
diff --git a/lib/private/update-package-json.js → lib/update-package-json.js b/lib/private/update-package-json.js → lib/update-package-json.js
diff --git a/package.json b/package.json
@@ -56,11 +56,11 @@
 		"overrides": [
 			{
 				"files": [
-					"lib/private/install-dependencies/index.js",
-					"lib/private/install-maintained-package/finalize.js",
-					"lib/private/setup-dependencies/index.js",
-					"lib/private/setup-dependencies/setup-required-dependencies.js",
-					"lib/private/update-all.js"
+					"lib/install-dependencies/index.js",
+					"lib/install-maintained-package/finalize.js",
+					"lib/setup-dependencies/index.js",
+					"lib/setup-dependencies/setup-required-dependencies.js",
+					"lib/update-all.js"
 				],
 				"rules": {
 					"no-await-in-loop": "off"

diff --git a/update-all.js b/update-all.js
@@ -1,9 +1,9 @@
 "use strict";
 
 const toPlainObject       = require("es5-ext/object/normalize-options")
-    , ensureConfiguration = require("./lib/private/ensure-user-configuration")
-    , createProgressData  = require("./lib/private/create-progress-data")
-    , updateAll           = require("./lib/private/update-all");
+    , ensureConfiguration = require("./lib/ensure-user-configuration")
+    , createProgressData  = require("./lib/create-progress-data")
+    , updateAll           = require("./lib/update-all");
 
 module.exports = (configuration, options = {}) => {
 	const progressData = createProgressData();