https://github.com/ethers-io/hijack-npm-action

GitHub action to run a faux NPM registry which intercepts select npm packages and injects local versions.
https://github.com/ethers-io/hijack-npm-action

Last synced: 4 months ago
JSON representation

GitHub action to run a faux NPM registry which intercepts select npm packages and injects local versions.

• Host: GitHub
• URL: https://github.com/ethers-io/hijack-npm-action
• Owner: ethers-io
• License: mit
• Created: 2023-04-21T08:44:37.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-12-20T07:39:57.000Z (over 1 year ago)
• Last Synced: 2024-05-23T08:20:56.246Z (about 1 year ago)
• Language: TypeScript
• Size: 70.3 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
Hijack NPM Registry

===================

Creates a faux NPM registry server, which will intercept select

npm install requests, providing unpublished, local packages while

forwarding all other packages to the official NPM registry.

This can be used to test how a package will behave once published,

before actually publishing it, including all `pakage.json` imports.

Configuration

-------------

This package was designed to test ethers under various installation

conditions, so the below example assumes the package being hijacked

(in the `./faux-npm/ethers/` folder) also contains the tests.

```

name: Test TypeScript Import

on:

  push:

    bracnhes:

      - master

jobs:

  test-import-typescript:

    name: Test Import TypeScript

    runs-on: ubuntu-latest

    env:

      npm_config_registry: http://localhost:8043

    steps:

      - name: Use Node.js

        uses: actions/setup-node@v1

        with:

          node-version: 18.x

      - name: Checkout repository

        uses: actions/checkout@v3

        with:

          path: "faux-npm/ethers"

      - name: Install and run Faux Registry

        uses: ethers-io/hijack-npm-action

      - name: Copy tests to working directory

        run: cp faux-npm/ethers/testcases/test-env/ts-import/* .

      - name: Install packages

        run: npm install

      - name: Run tests

        run: npm test

```

License

-------

MIT License.