Merge pull request #17 from kurone-kito/add-the-npm-version

v0.8.1: added the npm packages for the ReactJS and SolidJS

.commitlintrc.yml

@@ -0,0 +1,2 @@
+extends:
+  - '@kurone-kito/commitlint-config'

.gitattributes

@@ -13,4 +13,5 @@
 .coderabbit.yaml export-ignore
 .git* export-ignore
 .github/** export-ignore
+.husky/** export-ignore
 .imgbotconfig export-ignore

.github/dependabot.yml

@@ -10,3 +10,13 @@ updates:
       - kurone-kito
     schedule:
       interval: monthly
+  - directory: /
+    labels:
+      - dependencies
+    package-ecosystem: npm
+    reviewers:
+      - kurone-kito
+    assignees:
+      - kurone-kito
+    schedule:
+      interval: monthly

.github/workflows/build-listing.yml

@@ -39,6 +39,10 @@ jobs:
       url: ${{ steps.deployment.outputs.page_url }}
     runs-on: ubuntu-latest
     steps:
+      - name: Set git to use LF
+        run: |
+          git config --global core.autocrlf false
+          git config --global core.eol lf
       - name: Checkout Local Repository
         uses: actions/checkout@v4
       - name: Checkout Automation Repository without removing prior checkouts
@@ -47,6 +51,23 @@ jobs:
           repository: vrchat-community/package-list-action
           path: ${{ env.pathToCi }}
           clean: false
+      - name: Pre-prepare the Node.js environment
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: .node-version
+      - name: Enable the corepack because of the pnpm
+        run: corepack enable
+      - name: Post-prepare the Node.js environment
+        uses: actions/setup-node@v4
+        with:
+          cache: ${{ !env.ACT && 'pnpm' || '' }}
+          node-version-file: .node-version
+      - env:
+          HUSKY: 0
+        name: Install the dependencies
+        run: corepack up
+      - name: Run the build to generate the website
+        run: pnpm run build
       - name: Deploy the global.json file
         run: cp "${{ github.workspace }}/global.json" "${{ env.pathToCi }}/"
       - name: Load cached data from previous runs

.github/workflows/push.yml

@@ -7,7 +7,7 @@ on:
 permissions:
   contents: read
 jobs:
-  build:
+  build-unity:
     runs-on: ubuntu-latest
     env:
       listPublishDirectory: Website
@@ -20,7 +20,7 @@ jobs:
         uses: actions/checkout@v4
       - name: Zip the Package for testing
         run: zip -r "${{ github.workspace }}/${{ env.zipFile }}" .
-        working-directory: "${{ env.packagePath }}"
+        working-directory: '${{ env.packagePath }}'
       - name: Build a list of .meta files for future use
         run: find "${{ env.packagePath }}/" -name '*.meta' -type f >> metaList
       - name: Make a UnityPackage version of the Package for release
@@ -47,3 +47,46 @@ jobs:
         run: '"${{ env.pathToCi }}/build.cmd" BuildRepoListing --root "${{ env.pathToCi }}" --list-publish-directory "$GITHUB_WORKSPACE/${{ env.listPublishDirectory }}" --current-package-name "${{ vars.PACKAGE_NAME }}"'
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+  build-web:
+    defaults:
+      run:
+        shell: ${{ matrix.platform.shell }}
+    name: The build process
+    runs-on: ${{ matrix.platform.os }}
+    steps:
+      - name: Set git to use LF
+        run: |
+          git config --global core.autocrlf false
+          git config --global core.eol lf
+      - name: Stages the pushed branch
+        uses: actions/checkout@v4
+      - name: Pre-prepare the Node.js environment
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: .node-version
+      - name: Enable the corepack because of the pnpm
+        run: corepack enable
+      - name: Post-prepare the Node.js environment
+        uses: actions/setup-node@v4
+        with:
+          cache: ${{ !env.ACT && 'pnpm' || '' }}
+          node-version-file: .node-version
+      - env:
+          HUSKY: 0
+        name: Install the dependencies
+        run: pnpm install --prefer-frozen-lockfile
+      - name: Run the build
+        run: pnpm run build
+      - name: Run the tests
+        run: pnpm run test
+    strategy:
+      matrix:
+        platform:
+          - os: ubuntu-latest
+            shell: bash
+          - os: windows-latest
+            shell: bash
+          - os: windows-latest
+            shell: powershell
+      fail-fast: false
+    timeout-minutes: 30

.github/workflows/release.yml

@@ -5,6 +5,7 @@ on:
 
 jobs:
   config:
+    name: configuration
     runs-on: ubuntu-latest
     outputs:
       config_package: ${{ steps.config_package.outputs.configPackage }}
@@ -18,7 +19,36 @@ jobs:
             echo "configPackage=false" >> $GITHUB_OUTPUT;
           fi
 
-  build:
+  build-npm:
+    name: build the NPM package
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - name: Stages the pushed branch
+        uses: actions/checkout@v4
+      - name: Pre-prepare the Node.js environment
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: .node-version
+      - name: Enable the corepack because of the pnpm
+        run: corepack enable
+      - name: Post-prepare the Node.js environment
+        uses: actions/setup-node@v4
+        with:
+          cache: ${{ !env.ACT && 'pnpm' || '' }}
+          node-version-file: .node-version
+      - env:
+          HUSKY: 0
+        name: Install the dependencies
+        run: pnpm install --prefer-frozen-lockfile
+      - env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        name: Publish the packages
+        run: pnpm run publish
+
+  build-upm:
+    name: build the UPM package
     needs: config
     runs-on: ubuntu-latest
     permissions:
@@ -64,7 +94,7 @@ jobs:
           echo "version=${{ steps.version.outputs.value }}" >> $GITHUB_ENV
           echo "zipFile=${{ vars.PACKAGE_NAME }}-${{ steps.version.outputs.value }}.zip" >> $GITHUB_ENV
       - name: Zip the Package for release
-        working-directory: "${{ env.packagePath }}"
+        working-directory: '${{ env.packagePath }}'
         run: zip -r -9 "${{ github.workspace }}/${{ env.zipFile }}" .
       - name: Build a list of .meta files for future use
         run: find "${{ env.packagePath }}/" -name '*.meta' -type f >> metaList
@@ -87,7 +117,7 @@ jobs:
         # cspell: disable-next-line
         uses: rickstaa/action-create-tag@v1
         with:
-          tag: "${{ env.version }}"
+          tag: '${{ env.version }}'
           gpg_passphrase: ${{ secrets.GPG_PASSPHRASE }}
           gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }}
       - name: Publish the Release to GitHub

.gitignore

@@ -1,5 +1,5 @@
-# Created by https://www.toptal.com/developers/gitignore/api/linux,macos,unity,vim,visualstudiocode,windows
-# Edit at https://www.toptal.com/developers/gitignore?templates=linux,macos,unity,vim,visualstudiocode,windows
+# Created by https://www.toptal.com/developers/gitignore/api/linux,macos,node,unity,vim,visualstudiocode,windows,yarn
+# Edit at https://www.toptal.com/developers/gitignore?templates=linux,macos,node,unity,vim,visualstudiocode,windows,yarn
 
 ### Linux ###
 *~
@@ -49,6 +49,146 @@ Temporary Items
 # iCloud generated files
 *.icloud
 
+### Node ###
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+### Node Patch ###
+# Serverless Webpack directories
+.webpack/
+
+# Optional stylelint cache
+
+# SvelteKit build / generate output
+.svelte-kit
+
 ### Unity ###
 # This .gitignore file should be placed at the root of your Unity project directory
 #
@@ -187,10 +327,32 @@ $RECYCLE.BIN/
 # Windows shortcuts
 *.lnk
 
-# End of https://www.toptal.com/developers/gitignore/api/linux,macos,unity,vim,visualstudiocode,windows
+### yarn ###
+# https://yarnpkg.com/getting-started/qa#which-files-should-be-gitignored
+
+.yarn/*
+!.yarn/releases
+!.yarn/patches
+!.yarn/plugins
+!.yarn/sdks
+!.yarn/versions
+
+# if you are NOT using Zero-installs, then:
+# comment the following lines
+# !.yarn/cache
+
+# and uncomment the following lines
+.pnp.*
+
+# End of https://www.toptal.com/developers/gitignore/api/linux,macos,node,unity,vim,visualstudiocode,windows,yarn
 
 ### THE PROJECT SPECIFIES #################################################
 
+### Node ###
+nodePackages/*/LICENSE
+nodePackages/builder/assets
+nodePackages/*/generated-src
+
 ### Unity ###
 # Example scenes
 [Aa]ssets/Scenes*

.husky/commit-msg

@@ -0,0 +1,5 @@
+#!/bin/sh
+# -*- mode: sh -*-
+# vim: set ft=sh :
+
+pnpm exec commitlint --edit "${1}"

.husky/pre-commit

@@ -0,0 +1,5 @@
+#!/bin/sh
+# -*- mode: sh -*-
+# vim: set ft=sh :
+
+pnpm exec lint-staged

.lintstagedrc.mjs

@@ -0,0 +1 @@
+export { default } from '@kurone-kito/lint-staged-config/.lintstagedrc.json' with { type: 'json' };

.markdownlint-cli2.yaml

@@ -4,6 +4,8 @@ ignores:
   - Assets/**
   - Library/**
   - Logs/**
+  - node_modules/**
+  - nodePackages/**/docs/**
   - Packages/com.*/**
   - Packages/dev.*/**
   - ProjectSettings/**