first docs

2022-11-02 06:40:25 +00:00
parent 2b19f4a153
commit 96a526ef1e
2129 changed files with 174471 additions and 0 deletions
--- a/.yarn/unplugged/node-gyp-npm-9.3.0-21c41a4dfd/node_modules/node-gyp/.github/ISSUE_TEMPLATE.md
+++ b/.yarn/unplugged/node-gyp-npm-9.3.0-21c41a4dfd/node_modules/node-gyp/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,52 @@
+<!--
+Thank you for reporting an issue!
+
+Remember, this issue tracker is for reporting issues ONLY with node-gyp.
+
+If you have an issue installing a specific module, please file an issue on
+that module's issue tracker (`npm issues modulename`). Open issue here only if
+you are sure this is an issue with node-gyp, not with the module you are
+trying to build.
+
+Fill out the form below. We probably won't investigate an issue that does not
+provide the basic information we require.
+
+-->
+
+Please look thru your error log for the string `gyp info using node-gyp@` and if the version number is less than the [current release of node-gyp](https://github.com/nodejs/node-gyp/releases) then __please upgrade__ using the instructions at https://github.com/nodejs/node-gyp/blob/master/docs/Updating-npm-bundled-node-gyp.md and try your command again.
+
+Requests for help with [`node-sass` are very common](https://github.com/nodejs/node-gyp/issues?q=label%3A%22Node+Sass+--%3E+Dart+Sass%22). Please be aware that this package is deprecated, you should seek alternatives and avoid opening new issues about it here.
+
+* **Node Version**: <!-- `node -v` and `npm -v` -->
+* **Platform**: <!-- `uname -a` (UNIX), or `systeminfo | findstr /B /C:"OS Name" /C:"OS Version" /C:"System Type"` (Windows) -->
+* **Compiler**: <!-- `cc -v` (UNIX) or `msbuild /version & cl` (Windows) -->
+* **Module**: <!-- what you tried to build/install -->
+
+<details><summary>Verbose output (from npm or node-gyp):</summary>
+
+```
+Paste your log here, between the backticks. It can be:
+  - npm --verbose output,
+  - or contents of npm-debug.log,
+  - or output of node-gyp rebuild --verbose.
+Include the command you were trying to run.
+
+This should look like this:
+
+>npm --verbose
+npm info it worked if it ends with ok
+npm verb cli [
+npm verb cli   'C:\\...\\node\\13.9.0\\x64\\node.exe',
+npm verb cli   'C:\\...\\node\\13.9.0\\x64\\node_modules\\npm\\bin\\npm-cli.js',
+npm verb cli   '--verbose'
+npm verb cli ]
+npm info using npm@6.13.7
+npm info using node@v13.9.0
+
+Usage: npm <command>
+(...)
+```
+
+</details>
+
+<!-- Any further details -->
--- a/.yarn/unplugged/node-gyp-npm-9.3.0-21c41a4dfd/node_modules/node-gyp/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.yarn/unplugged/node-gyp-npm-9.3.0-21c41a4dfd/node_modules/node-gyp/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,17 @@
+<!--
+Thank you for your pull request. Please review the below requirements.
+
+Contributor guide: https://github.com/nodejs/node/blob/master/CONTRIBUTING.md
+-->
+
+##### Checklist
+<!-- Remove items that do not apply. For completed items, change [ ] to [x]. -->
+
+- [ ] `npm install && npm test` passes
+- [ ] tests are included <!-- Bug fixes and new features should include tests -->
+- [ ] documentation is changed or added
+- [ ] commit message follows [commit guidelines](https://github.com/googleapis/release-please#how-should-i-write-my-commits)
+
+##### Description of change
+<!-- Provide a description of the change -->
+
--- a/.yarn/unplugged/node-gyp-npm-9.3.0-21c41a4dfd/node_modules/node-gyp/.github/workflows/release-please.yml
+++ b/.yarn/unplugged/node-gyp-npm-9.3.0-21c41a4dfd/node_modules/node-gyp/.github/workflows/release-please.yml
@@ -0,0 +1,56 @@
+name: release-please
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: google-github-actions/release-please-action@v2
+        id: release
+        with:
+          package-name: node-gyp
+          release-type: node
+          changelog-types: >
+            [{"type":"feat","section":"Features","hidden":false},
+            {"type":"fix","section":"Bug Fixes","hidden":false},
+            {"type":"bin","section":"Core","hidden":false},
+            {"type":"gyp","section":"Core","hidden":false},
+            {"type":"lib","section":"Core","hidden":false},
+            {"type":"src","section":"Core","hidden":false},
+            {"type":"test","section":"Tests","hidden":false},
+            {"type":"build","section":"Core","hidden":false},
+            {"type":"clean","section":"Core","hidden":false},
+            {"type":"configure","section":"Core","hidden":false},
+            {"type":"install","section":"Core","hidden":false},
+            {"type":"list","section":"Core","hidden":false},
+            {"type":"rebuild","section":"Core","hidden":false},
+            {"type":"remove","section":"Core","hidden":false},
+            {"type":"deps","section":"Core","hidden":false},
+            {"type":"python","section":"Core","hidden":false},
+            {"type":"lin","section":"Core","hidden":false},
+            {"type":"linux","section":"Core","hidden":false},
+            {"type":"mac","section":"Core","hidden":false},
+            {"type":"macos","section":"Core","hidden":false},
+            {"type":"win","section":"Core","hidden":false},
+            {"type":"windows","section":"Core","hidden":false},
+            {"type":"zos","section":"Core","hidden":false},
+            {"type":"doc","section":"Doc","hidden":false},
+            {"type":"docs","section":"Doc","hidden":false},
+            {"type":"readme","section":"Doc","hidden":false},
+            {"type":"chore","section":"Miscellaneous","hidden":false},
+            {"type":"refactor","section":"Miscellaneous","hidden":false},
+            {"type":"ci","section":"Miscellaneous","hidden":false},
+            {"type":"meta","section":"Miscellaneous","hidden":false}]
+
+          # Standard Conventional Commits: `feat` and `fix`
+          # node-gyp subdirectories: `bin`, `gyp`, `lib`, `src`, `test`
+          # node-gyp subcommands: `build`, `clean`, `configure`, `install`, `list`, `rebuild`, `remove`
+          # Core abstract category: `deps`
+          # Languages/platforms: `python`, `lin`, `linux`, `mac`, `macos`, `win`, `window`, `zos`
+          # Documentation: `doc`, `docs`, `readme`
+          # Standard Conventional Commits: `chore` (under "Miscellaneous")
+          # Miscellaneous abstract categories: `refactor`, `ci`, `meta`
--- a/.yarn/unplugged/node-gyp-npm-9.3.0-21c41a4dfd/node_modules/node-gyp/.github/workflows/tests.yml
+++ b/.yarn/unplugged/node-gyp-npm-9.3.0-21c41a4dfd/node_modules/node-gyp/.github/workflows/tests.yml
@@ -0,0 +1,52 @@
+# https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners#supported-runners-and-hardware-resources
+# TODO: Line 48, enable pytest --doctest-modules
+
+name: Tests
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+jobs:
+  Tests:
+    strategy:
+      fail-fast: false
+      max-parallel: 15
+      matrix:
+        node: [14.x, 16.x, 18.x]
+        python: ["3.6", "3.8", "3.10"]
+        os: [macos-latest, ubuntu-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node }}
+      - name: Use Python ${{ matrix.python }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python }}
+        env:
+          PYTHON_VERSION: ${{ matrix.python }}  # Why do this?
+      - name: Install Dependencies
+        run: |
+          npm install --no-progress
+          pip install flake8 pytest
+      - name: Set Windows environment
+        if: startsWith(matrix.os, 'windows')
+        run: |
+          echo 'GYP_MSVS_VERSION=2015' >> $Env:GITHUB_ENV
+          echo 'GYP_MSVS_OVERRIDE_PATH=C:\\Dummy' >> $Env:GITHUB_ENV
+      - name: Lint Python
+        if: startsWith(matrix.os, 'ubuntu')
+        run: flake8 . --ignore=E203,W503  --max-complexity=101 --max-line-length=88 --show-source --statistics
+      - name: Run Python tests
+        run: python -m pytest
+      # - name: Run doctests with pytest
+      #   run: python -m pytest --doctest-modules
+      - name: Environment Information
+        run: npx envinfo
+      - name: Run Node tests
+        run: npm test
--- a/.yarn/unplugged/node-gyp-npm-9.3.0-21c41a4dfd/node_modules/node-gyp/.github/workflows/visual-studio.yml
+++ b/.yarn/unplugged/node-gyp-npm-9.3.0-21c41a4dfd/node_modules/node-gyp/.github/workflows/visual-studio.yml
@@ -0,0 +1,33 @@
+# https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners#supported-runners-and-hardware-resources
+
+name: visual-studio
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+jobs:
+  visual-studio:
+    strategy:
+      fail-fast: false
+      max-parallel: 8
+      matrix:
+        os: [windows-latest]
+        msvs-version: [2016, 2019, 2022]  # https://github.com/actions/virtual-environments/tree/main/images/win
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v3
+      - name: Install Dependencies
+        run: |
+          npm install --no-progress
+          # npm audit fix --force
+      - name: Set Windows environment
+        if: startsWith(matrix.os, 'windows')
+        run: |
+          echo 'GYP_MSVS_VERSION=${{ matrix.msvs-version }}' >> $Env:GITHUB_ENV
+          echo 'GYP_MSVS_OVERRIDE_PATH=C:\\Dummy' >> $Env:GITHUB_ENV
+      - name: Environment Information
+        run: npx envinfo
+      - name: Run Node tests
+        run: npm test