Merge pull request #11 from react18-tools/rewrite

Rewrite

Author: mayank1513

.changeset/config.json

@@ -1,11 +1,11 @@
 {
-  "$schema": "https://unpkg.com/@changesets/config@2.3.1/schema.json",
+  "$schema": "https://unpkg.com/@changesets/config@3.0.0/schema.json",
   "changelog": "@changesets/cli/changelog",
   "commit": false,
   "fixed": [],
   "linked": [],
   "access": "restricted",
   "baseBranch": "main",
   "updateInternalDependencies": "patch",
-  "ignore": []
+  "ignore": ["@example/*"]
 }

.deepsource.toml

@@ -1,12 +1,12 @@
 version = 1
 
-test_patterns = [
-  "test/**/*.*",
+test_patterns = ["**/*.test.*"]
+
+exclude_patterns = [
+  "docs/**",
   "**/*.test.*"
 ]
 
-exclude_patterns = ["docs/**"]
-
 [[analyzers]]
 name = "javascript"
 

.github/FUNDING.yml

@@ -1,6 +1,7 @@
 # These are supported funding model platforms
 
-github: [mayank1513] # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+github: [react18-tools, mayank1513] # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+polar: mayank1513
 patreon: # Replace with a single Patreon username
 open_collective: # Replace with a single Open Collective username
 ko_fi: # Replace with a single Ko-fi username

.github/workflows/docs.yml

@@ -10,7 +10,6 @@ jobs:
     if: github.event.repository.owner.login == 'react18-tools'
     runs-on: ubuntu-latest
     permissions:
-      packages: write
       contents: write
     steps:
       - uses: actions/checkout@v4
@@ -21,25 +20,26 @@ jobs:
         with:
           registry-url: https://registry.npmjs.org
           node-version: 20
+      - name: Setup Git
+        run: |
+          git config --global user.name "mayank1513"
+          git config --global user.email "[email protected]"
+          git fetch
+          git checkout main
+          git pull
       - run: npm i -g pnpm && pnpm i
         name: Install dependencies
       - name: Test
         run: npm test
       - run: git status && git clean -f -d && git status
         name: clean up working directory
-      - run: npx @turbo/codemod update . && pnpm update --latest -w
+      - run: npx @turbo/codemod update . && pnpm update --latest -r
         name: Update dependencies
       - run: pnpm build
         name: Build all apps to make sure it is not broken due to dependency upgrades
       - name: Run unit tests
         run: pnpm test
       - name: Generate/update docs
         run: pnpm doc
-      - name: Setup Git
-        run: |
-          git config --global user.name "react18-tools"
-          git config --global user.email "[email protected]"
-          git fetch
-          git checkout main
       - name: Save upgraded packages back to repo
         run: git add . && git commit -m "upgrade deps && docs" && git push origin main

.github/workflows/manual-publish.yml

@@ -0,0 +1,44 @@
+name: Manually publish to NPM - Apply changeset in the workflow.
+
+# publish only when package json has changed - assuming version upgrade
+on:
+  workflow_dispatch:
+
+jobs:
+  publish:
+    if: github.event.repository.owner.login == 'react18-tools'
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          registry-url: https://registry.npmjs.org
+      - name: Setup Git
+        run: |
+          git config --global user.name "mayank1513"
+          git config --global user.email "[email protected]"
+      - run: npm i -g pnpm && pnpm i
+        name: Install dependencies
+        # fail and not publish if any of the unit tests are failing
+      - name: Test
+        run: pnpm test
+      - name: clean up working directory
+        run: git status && git clean -f -d && git status
+      - name: Copy Readme file
+        run: cp ./README.md ./lib # todo: uncomment this line while rebranding
+      - name: Apply changesets, publish and create release, branches and tags
+        run: node ./scripts/manual-publish.js
+        env:
+          BRANCH: ${{ github.ref_name }}
+          DEFAULT_BRANCH: ${{ github.event.repository.default_branch }}
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/publish.yml

@@ -4,21 +4,18 @@ name: Publish to NPM
 on:
   push:
     branches: [main]
-    paths: "lib/nthul/package.json"
+    paths: "lib/package.json"
 
 jobs:
   publish:
-    if: github.event.repository.owner.login == 'react18-tools'
+    # Don't run just after creating repo from template
+    # Also avoid running after merging set-up PR
+    if: github.run_number > 2 && github.event.repository.owner.login == 'react18-tools'
     runs-on: ubuntu-latest
     permissions:
-      packages: write
       contents: write
       id-token: write
 
-    defaults:
-      run:
-        working-directory: ./lib/nthul
-
     steps:
       - uses: actions/checkout@v4
         with:
@@ -28,47 +25,22 @@ jobs:
         with:
           node-version: 20
           registry-url: https://registry.npmjs.org
+      - name: Setup Git
+        run: |
+          git config --global user.name "mayank1513"
+          git config --global user.email "[email protected]"
       - run: npm i -g pnpm && pnpm i
         name: Install dependencies
         # fail and not publish if any of the unit tests are failing
       - name: Test
         run: pnpm test
-      - name: Create release and publish to NPM
-        run: pnpm build && pnpm publish-package && node scope.js && pnpm publish-package
-        # continue on error to publish scoped package name <- by default repo is setup for a non-scoped + scoped package name
-        continue-on-error: true
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
-          TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          OWNER: ${{ github.event.repository.owner.login }}
-          REPO: ${{ github.event.repository.name }}
-
-      - name: Publish package with long name for better SEO
-        continue-on-error: true
-        run: |
-          cd dist
-          sed -i -e "s/.*name.*/\t\"name\": \"nextjs-themes-ultra\",/" package.json
-          npm publish --provenance --access public
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
-
-      # Publish lite version
-      - run: node lite.js && pnpm build && pnpm publish-package && node scope.js && pnpm publish-package
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
-
-      - name: Publish package with long name for better SEO
-        continue-on-error: true
-        run: |
-          cd dist
-          sed -i -e "s/.*name.*/\t\"name\": \"nextjs-themes-ultralite\",/" package.json
-          npm publish --provenance --access public
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
-
-      - name: Mark scoped package as deprecated
-        run: |
-          npm deprecate @mayank1513/nthul "Please use <https://www.npmjs.com/package/nathul> instead. We initially created scoped packages to have similarities with the GitHub Public Repository (which requires packages to be scoped). We are no longer using GPR and thus deprecating all scoped packages for which corresponding un-scoped packages exist."
-          npm deprecate @mayank1513/nthul-lite "Please use <https://www.npmjs.com/package/nthul-lite> instead. We initially created scoped packages to have similarities with the GitHub Public Repository (which requires packages to be scoped). We are no longer using GPR and thus deprecating all scoped packages for which corresponding un-scoped packages exist."
+      - name: Copy Readme file
+        run: cp ./README.md ./lib # will be uncommented while rebranding
+      - name: Apply changesets, publish and create release, branches and tags
+        run: node ./scripts/publish.js
         env:
+          BRANCH: ${{ github.ref_name }}
+          DEFAULT_BRANCH: ${{ github.event.repository.default_branch }}
           NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/test.yml

@@ -7,28 +7,30 @@ on:
     - cron: "5 */8 * * *"
 jobs:
   test:
+    if: github.run_number != 1
     runs-on: ubuntu-latest
-    permissions:
-      contents: write
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
           node-version: 20
+      - name: Setup Git
+        run: |
+          git config --global user.name "mayank1513"
+          git config --global user.email "[email protected]"
       - run: npm i -g pnpm && pnpm i
         name: Install dependencies
       - name: Run unit tests
         run: pnpm test
       - name: Upload coverage reports to Codecov
         continue-on-error: true
-        uses: codecov/codecov-action@v3
+        uses: codecov/codecov-action@v4
         with:
-          directory: ./lib/nthul
+          directory: ./lib
           token: ${{ secrets.CODECOV_TOKEN }}
-          flags: nthul
       - uses: paambaati/[email protected]
         continue-on-error: true
         env:
           CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
         with:
-          coverageLocations: ./lib/nthul/coverage/*.xml:clover
+          coverageLocations: ./lib/coverage/*.xml:clover

.gitignore

@@ -1,39 +1,16 @@
-# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
-
-# dependencies
-node_modules
-.pnp
-.pnp.js
-
-# testing
-coverage
-
-# next.js
-.next/
-out/
-build
-
-# misc
 .DS_Store
-*.pem
-
-# debug
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-
-# local env files
-.env
-.env.local
-.env.development.local
-.env.test.local
-.env.production.local
-
-# turbo
+node_modules
 .turbo
+*.log
+.next
+dist
+dist-ssr
+*.local
+.env
+.cache
 
-# vercel
-.vercel
+# test coverage
+coverage
 
-# lock files
-*lock*
+# temporary files
+tsup.config.bundled*

.prettierignore

@@ -3,3 +3,4 @@
 # ignore hbs files as prettier removes all spaces and makes it ugly
 *hbs
 docs
+.vscode

.prettierrc

@@ -1,6 +1,6 @@
 {
   "singleQuote": false,
-  "printWidth": 120,
+  "printWidth": 100,
   "tabWidth": 2,
   "arrowParens": "avoid",
   "jsxBracketSameLine": true,