Import source code for pko 0.0.1

.gitignore

@@ -0,0 +1,3 @@
+/node_modules
+*.d.ts
+*.js

.npmignore

@@ -0,0 +1,2 @@
+*.ts
+!*.d.ts

LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2018-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

README.md

@@ -0,0 +1,63 @@
+# `pko`
+`pko` is a drop-in replacement for `npm` that uses local files instead of the standard `npm` registry for the packages
+it has been set up with. If you're wondering why you would want to do such things, refer to the [use-cases](#Use-cases)
+section of this document.
+
+*npm is a registered trademark of npm, Inc.*
+
+# Usage
+## Adding a package to the `pko` overlay
+Simply publish your packages using the `pko` command instead of the `npm` command (this cannot work for packages that
+have `publishConfig` or `private: true` in their `package.json` file). No authentication is required.
+* For a package you're developing:
+  ```shell
+  pko publish path/to/package
+  ```
+* For a package from your `npm` registry of choice:
+  ```shell
+  TGZ=$(npm pack package[@version]) # Download the package locally
+  pko publish ${TGZ}              # Publish the downloaded package
+  rm ${TGZ}                         # Clean-up after yourself
+  ```
+
+## Determine which packages you have in the `pko` overlay
+The `ls-overrides` subcommand will list all packages present in the local overlay and output their name and (latest)
+version number to `STDOUT`.
+```shell
+pko ls-overrides
+```
+
+## Install packages using the `pko` overlay
+Simply replace invokations of `npm` with `pko`, using the exact same arguments:
+```shell
+pko install
+pko install --save-dev @types/node
+pko run build
+```
+
+## Overlay location
+The overlay location is determined using the following procedure:
+1. The environment variable `$PKO_REPOSITORY`
+2. Walk up the tree from `$PWD` (the process' working directory) until:
+    1. A `.pko` directory is found
+    2. The root of the filesystem is reached
+3. Walk up the tree from where `pko` is installed in until:
+    1. A `.pko` directory is found
+    2. The root of the filesystem is reached
+4. Bail out in error.
+
+## Debugging
+Verbose logging can be enabled by setting the `PKO_VERBOSE` environment variable to a truthy value:
+```shell
+PKO_VERBOSE=1 pko install
+```
+
+# Use-cases
+* Distributing private packages without having to set-up a full-fledged `npm` registry for private use.
+  > Simply prepare an overlay locally, then distribute that overlay (for example, in a ZIP file) to interested users.
+* Enable full offline usage of `npm`
+  > Prepare an overlay with all the package versions that need to be available offline. No internet connectivity will
+  > be required for using those.
+* Replacing a dependency with customized code (for quick experimentations, ...)
+  > Publish your custom version under the exact same name as the package you want to replace to your overlay, and
+  > `pko` will use that instead of the version found in the public `npm` registry.

bin/pko

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+require('./pko.js');

bin/pko.template.cmd

@@ -0,0 +1,7 @@
+@IF EXIST "%~dp0\node.exe" (
+  "%~dp0\node.exe"  "%~dp0\..\pko\bin\pko" %*
+) ELSE (
+  @SETLOCAL
+  @SET PATHEXT=%PATHEXT:;.JS;=;%
+  node "%~dp0\..\pko\bin\pko" %*
+)

bin/pko.ts

@@ -0,0 +1,58 @@
+import 'source-map-support/register';
+
+import colors = require('colors/safe');
+import fs = require('fs-extra');
+import { determineStorageDirectory } from '../lib/determine-storage-directory';
+import { findAllPackages } from '../lib/find-all-packages';
+import { debug, setVerbose } from '../lib/logging';
+import { runNpmCommand } from '../lib/run-npm-command';
+import { withVerdaccio } from '../lib/start-verdaccio';
+import { withTemporaryFile } from '../lib/with-temporary-file';
+
+async function main(argv: string[]): Promise<number> {
+  // Disable colors if $PKO_NO_COLOR is set to a truthy value
+  if (process.env.PKO_NO_COLOR) {
+    colors.disable();
+  }
+  // Make verbose if $PKO_VERBOSE is set to a truthy value
+  if (process.env.PKO_VERBOSE) {
+    setVerbose(true);
+    debug(`Verbose logging enabled by $PKO_VERBOSE=${process.env.PKO_VERBOSE}`);
+  }
+  debug(`Arguments: ${JSON.stringify(argv)}`);
+
+  const storage = await determineStorageDirectory();
+  if (argv.length === 1) {
+    switch (argv[0]) {
+    case 'ls-overrides':
+      debug(`Invoking pko command: ls-overrides`);
+      await listLocalPackages();
+      return 0;
+    }
+  }
+
+  return (await withTemporaryFile('npmrc', async npmrc => {
+    return await withVerdaccio(storage, argv.find(arg => arg === 'publish') != null, async verdaccio => {
+      const userConfig = `registry=http:${verdaccio.endpoint}\n${verdaccio.endpoint}:_authToken=none\n`;
+      debug(`Writing user config to ${colors.green(npmrc)}:\n${colors.blue(userConfig)}`);
+      await fs.writeFile(npmrc, userConfig);
+      return await(await runNpmCommand(argv, { npm_config_registry: undefined, npm_config_userconfig: npmrc }));
+    });
+  })).exitCode;
+
+  // ### Helper functions ###
+
+  async function listLocalPackages(dir: string = storage) {
+    for (const pkg of await findAllPackages(dir)) {
+      process.stdout.write(`${colors.green(pkg.name)}@${colors.blue(pkg.maxVersion || '*')}\n`);
+    }
+  }
+}
+
+main(process.argv.slice(2))
+  .then(exitCode => process.exit(exitCode))
+  .catch(err => {
+    // tslint:disable-next-line:no-console
+    console.error(err.stack);
+    process.exit(-1);
+  });

lib/determine-storage-directory.ts

@@ -0,0 +1,52 @@
+import fs = require('fs-extra');
+import path = require('path');
+import { debug } from './logging';
+
+/** The parent directory of this module's location */
+const installRoot = path.resolve(path.join(__dirname, '..', '..'));
+/** The standard name of pko overlay directories */
+const overlayName = path.join('.pko');
+
+/**
+ * Determines the directory where the overlay is located, using the following workflow:
+ *   1. ${PKO_REPOSITORY}
+ *   2. Walk up the tree from ${cwd} until:
+ *      * A .pko directory is found
+ *      * The root of the filesystem is reached
+ *   3. Walk up the tree from the module's install location until:
+ *      * A .pko directory is found
+ *      * The root of the filesystem is reached
+ *   4. Bail out in error.
+ * @returns the directory where the overlay directory is located.
+ */
+export async function determineStorageDirectory() {
+  let result: string | undefined = process.env.PKO_REPOSITORY;
+  if (!result) { result = await findOverlayDirectory(process.cwd()); }
+  if (!result) { result = await findOverlayDirectory(installRoot); }
+  if (!result) {
+    throw new Error(`Unable to locate the ${overlayName} overlay directory, maybe you should set the PKO_REPOSITORY environment variable?`);
+  }
+  debug(`Storage directory: ${result} (override by setting the PKO_REPOSITORY environment variable)`);
+  if (!await fs.pathExists(result)) {
+    throw new Error(`Storage directory does not exist: ${result}`);
+  }
+  return result;
+}
+
+/**
+ * Search for an overlay directory in a tree structure, walking up from the provided directory.
+ * @param dir the directory where the search starts
+ * @returns the full path to the overlay directory, or ``undefined`` if the root
+ *      of the filesystem is reached without finding one.
+ */
+async function findOverlayDirectory(dir: string): Promise<string | undefined> {
+  const candidate = path.join(dir, overlayName);
+  if (await fs.pathExists(candidate)) {
+    return path.normalize(candidate);
+  }
+  const parent = path.normalize(path.resolve(path.join(dir, '..')));
+  if (parent !== dir) {
+    return await findOverlayDirectory(parent);
+  }
+  return undefined;
+}