@adbayb/stack 1.16.1 → 2.1.0

package/package.json

@@ -1,21 +1,29 @@
 {
   "name": "@adbayb/stack",
-  "version": "1.16.1",
-  "description": "My opinionated toolchain",
+  "version": "2.1.0",
+  "description": "My opinionated JavaScript-based toolchain",
   "publishConfig": {
     "access": "public"
   },
   "files": [
     "bin",
+    "configs",
     "dist",
-    "template"
+    "templates"
   ],
   "bin": {
-    "stack": "bin/index.cjs"
+    "stack": "./bin/index.js"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "source": "./src/index.ts",
+      "default": "./dist/index.js"
+    },
+    "./eslint": "./configs/eslint/index.js",
+    "./prettier": "./configs/prettier/index.js",
+    "./typescript": "./configs/typescript/index.json"
   },
-  "source": "src/index.ts",
-  "main": "dist/index.cjs",
-  "platform": "node",
   "keywords": [
     "stack",
     "scripts",
@@ -30,24 +38,46 @@
   "repository": {
     "type": "git",
     "url": "https://github.com/adbayb/stack.git",
-    "directory": "stack"
+    "directory": "applications/stack"
   },
   "license": "MIT",
+  "devDependencies": {
+    "@types/node": "22.9.0",
+    "quickbundle": "2.6.0"
+  },
   "dependencies": {
     "@changesets/changelog-github": "^0.5.0",
-    "@changesets/cli": "^2.27.1",
-    "@commitlint/cli": "^18.6.1",
-    "@commitlint/config-conventional": "^18.6.2",
-    "eslint": "^8.56.0",
-    "fdir": "^6.1.1",
-    "prettier": "^3.2.5",
-    "termost": "^0.12.0",
-    "turbo": "^1.12.4",
-    "typescript": "^5.3.3"
+    "@changesets/cli": "^2.27.9",
+    "@commitlint/cli": "^19.5.0",
+    "@commitlint/config-conventional": "^19.5.0",
+    "@eslint/compat": "^1.2.2",
+    "@eslint/eslintrc": "^3.1.0",
+    "@stylistic/eslint-plugin": "^2.10.1",
+    "@vitest/eslint-plugin": "^1.1.7",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-import-resolver-typescript": "^3.6.3",
+    "eslint-plugin-import-x": "^4.4.0",
+    "eslint-plugin-jest-formatting": "^3.1.0",
+    "eslint-plugin-jsdoc": "^50.4.3",
+    "eslint-plugin-mdx": "^3.1.5",
+    "eslint-plugin-n": "^17.12.0",
+    "eslint-plugin-prettier": "^5.2.1",
+    "eslint-plugin-react-hooks": "^5.0.0",
+    "eslint-plugin-react": "^7.37.2",
+    "eslint-plugin-sonarjs": "^2.0.4",
+    "eslint-plugin-sort-keys-custom-order": "^2.2.0",
+    "eslint": "^9.14.0",
+    "fdir": "^6.4.2",
+    "globals": "^15.12.0",
+    "prettier": "^3.3.3",
+    "termost": "^0.18.0",
+    "turbo": "^2.2.3",
+    "typescript-eslint": "^8.13.0",
+    "typescript": "^5.6.3"
   },
   "scripts": {
     "prestart": "pnpm build",
-    "start": "bin/index.js",
+    "start": "./bin/index.js",
     "build": "quickbundle build",
     "watch": "quickbundle watch"
   }

package/{template → templates/multi-projects}/.editorconfig

@@ -1,4 +1,4 @@
 root = true
 
 [*]
-indent_size = 4
+indent_size = 2

package/templates/multi-projects/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,4 @@
+blank_issues_enabled: false
+contact_links:
+  - name: 🤔 Questions and Help
+    about: Issues are dedicated to bugs, if you have any question, please use the dedicated GitHub discussion category.

package/templates/multi-projects/.github/workflows/continuous_delivery.yml

@@ -0,0 +1,61 @@
+name: Continous delivery
+
+on:
+  push:
+    branches:
+      - main
+
+concurrency: ${{ github.workflow }}-${{ github.ref }}
+
+jobs:
+  integrate:
+    uses: ./.github/workflows/workflow.yml
+  release:
+    timeout-minutes: 5
+    needs: integrate
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v4
+      - name: Get node version
+        run: echo "version=$(cat .nvmrc)" >> $GITHUB_OUTPUT
+        id: node
+      - name: Setup node ${{ steps.node.outputs.version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ steps.node.outputs.version }}
+          cache: pnpm
+      - name: Setup .npmrc
+        run: |
+          cat << EOF > "$HOME/.npmrc"
+            //registry.npmjs.org/:_authToken=$NPM_TOKEN
+          EOF
+        env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+      - name: Publish pre-release version(s)
+        if: "!contains(github.event.head_commit.message, 'chore: release package(s)')"
+        run: |
+          pnpm --filter=\!@examples/\* --recursive exec pnpm version "$(pnpm show ./ version)-next-${GITHUB_SHA::7}"
+          pnpm --filter=\!@examples/\* --recursive exec pnpm publish --tag next --no-git-checks
+      - name: Create release pull request
+        if: "!contains(github.event.head_commit.message, 'chore: release package(s)')"
+        uses: changesets/action@v1
+        with:
+          commit: "chore: release package(s)"
+          title: "chore: release package(s)"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Publish stable version(s)
+        if: "contains(github.event.head_commit.message, 'chore: release package(s)')"
+        uses: changesets/action@v1
+        with:
+          version: pnpm release:version
+          publish: pnpm release:publish
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

package/templates/multi-projects/.github/workflows/continuous_integration.yml

@@ -0,0 +1,9 @@
+name: Continuous integration
+
+on:
+  push:
+    branches-ignore: main
+
+jobs:
+  main:
+    uses: ./.github/workflows/workflow.yml

package/templates/multi-projects/.github/workflows/conventional_commit.yml

@@ -0,0 +1,48 @@
+name: Conventional commit
+
+on:
+  pull_request:
+    types: [opened, edited]
+
+jobs:
+  main:
+    timeout-minutes: 5
+    runs-on: ubuntu-latest
+    steps:
+      - uses: amannn/action-semantic-pull-request@v5
+        id: check_pr_rule
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          types: |
+            build
+            chore
+            ci
+            docs
+            feat
+            fix
+            perf
+            refactor
+            revert
+            style
+            test
+          requireScope: false
+          subjectPattern: ^(?![A-Z]).+$
+          subjectPatternError: The subject must start with a lowercase character
+      # Create a sticky comment to display the detailed error
+      - uses: marocchino/sticky-pull-request-comment@v2
+        if: always() && (steps.check_pr_rule.outputs.error_message != null)
+        with:
+          header: check_pr_comment
+          message: |
+            Pull request titles must follow the [Conventional Commits specification](https://www.conventionalcommits.org/).
+            Please adjust your title following:
+            ```
+            ${{ steps.check_pr_rule.outputs.error_message }}
+            ```
+      # Delete a previous comment when the issue has been resolved
+      - if: ${{ steps.check_pr_rule.outputs.error_message == null }}
+        uses: marocchino/sticky-pull-request-comment@v2
+        with:
+          header: check_pr_comment
+          delete: true

package/templates/multi-projects/.github/workflows/dependency_changelog.yml

@@ -0,0 +1,117 @@
+name: Dependency changelog
+
+on:
+  pull_request_target:
+    paths:
+      - "**/pnpm-lock.yaml"
+
+jobs:
+  main:
+    timeout-minutes: 5
+    runs-on: ubuntu-latest
+    if: github.actor == 'renovate[bot]'
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 2
+          ref: ${{ github.head_ref }}
+      - name: Configure Git
+        run: |
+          git config --global user.email adbayb@gmail.com
+          git config --global user.name 'Ayoub Adib'
+      - name: Create changelog entry
+        uses: actions/github-script@v7
+        # Credits to https://github.com/backstage/backstage/blob/bcc11651add5a2589898dfb9d665ebb9d412201b/.github/workflows/sync_renovate-changesets.yml
+        with:
+          script: |
+            const { promises: fs } = require("fs");
+
+            async function getPackagesNames(files) {
+              const names = [];
+
+              for (const file of files) {
+                const data = JSON.parse(await fs.readFile(file, "utf8"));
+                
+                if (!data.private) {
+                  names.push(data.name);
+                }
+              }
+
+              return names;
+            }
+
+            async function createChangeset(fileName, packageBumps, packages) {
+              let message = "";
+
+              for (const [pkg, bump] of packageBumps) {
+                message = message + `Updated dependency \`${pkg}\` to \`${bump}\`.\n`;
+              }
+
+              const pkgs = packages.map((pkg) => `"${pkg}": minor`).join("\n");
+              const body = `---\n${pkgs}\n---\n\n${message.trim()}\n`;
+              
+              await fs.writeFile(fileName, body);
+            }
+
+            async function getBumps(files) {
+              const bumps = new Map();
+
+              for (const file of files) {
+                const { stdout: changes } = await exec.getExecOutput("git", [
+                  "show",
+                  file,
+                ]);
+
+                for (const change of changes.split("\n")) {
+                  if (!change.match(/^\+\s/)) {
+                    continue;
+                  }
+
+                  const match = change.match(/"(.*?)"/g);
+
+                  bumps.set(match[0].replace(/"/g, ""), match[1].replace(/"/g, ""));
+                }
+              }
+
+              return bumps;
+            }
+
+            const branch = await exec.getExecOutput("git branch --show-current");
+
+            if (!branch.stdout.startsWith("renovate/")) {
+              console.log("Not a renovate branch, skipping");
+
+              return;
+            }
+
+            const diffOutput = await exec.getExecOutput("git diff --name-only HEAD~1");
+            const diffFiles = diffOutput.stdout.split("\n");
+
+            if (diffFiles.find((f) => f.startsWith(".changeset"))) {
+              console.log("Changeset already exists, skipping");
+
+              return;
+            }
+
+            const files = diffFiles
+              .filter((file) => file !== "package.json") // skip root package.json
+              .filter((file) => file.includes("package.json"));
+            const packageNames = await getPackagesNames(files);
+
+            if (!packageNames.length) {
+              console.log("No package.json changes to published packages, skipping");
+
+              return;
+            }
+
+            const { stdout: shortHash } = await exec.getExecOutput(
+              "git rev-parse --short HEAD"
+            );
+            const fileName = `.changeset/renovate-${shortHash.trim()}.md`;
+            const packageBumps = await getBumps(files);
+
+            await createChangeset(fileName, packageBumps, packageNames);
+            await exec.exec("git", ["add", fileName]);
+            await exec.exec("git commit -C HEAD --amend --no-edit");
+            await exec.exec("git push --force");

package/templates/multi-projects/.github/workflows/workflow.yml

@@ -0,0 +1,39 @@
+name: Main shareable workflow
+
+on:
+  workflow_call:
+
+jobs:
+  main:
+    timeout-minutes: 5
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout the code
+        uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v4
+      - name: Get node version
+        run: echo "version=$(cat .nvmrc)" >> $GITHUB_OUTPUT
+        id: node
+      - name: Setup node ${{ steps.node.outputs.version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ steps.node.outputs.version }}
+          cache: pnpm
+      - name: Setup cache
+        id: cache
+        uses: actions/cache@v4
+        with:
+          path: |
+            ./node_modules
+            ./turbo
+          key: ${{ runner.os }}-cache-${{ github.sha }}
+          restore-keys: |
+            ${{ runner.os }}-cache-
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+      - name: Build
+        run: pnpm build
+      - name: Check (static analysis including linters, types, and commit message)
+        run: pnpm check
+      - name: Test
+        run: pnpm test

package/{template → templates/multi-projects}/.npmrc.tmpl

@@ -5,3 +5,4 @@ public-hoist-pattern[]=*eslint*
 public-hoist-pattern[]=*prettier*
 public-hoist-pattern[]=*turbo*
 public-hoist-pattern[]=*typescript*
+public-hoist-pattern[]=*types*

package/templates/multi-projects/applications/README.md

@@ -0,0 +1,6 @@
+# Applications
+
+> [!note]
+> Optional folder that can be removed if there is no planned use case.
+
+A collection of application-like projects. An application is a runnable program (a command-line interface, a mobile/web application, ...).

package/templates/multi-projects/eslint.config.js.tmpl

@@ -0,0 +1 @@
+export { default } from "@adbayb/stack/eslint";

package/templates/multi-projects/examples/README.md

@@ -0,0 +1,6 @@
+# Examples
+
+A collection of examples to:
+
+- Showcase the artifacts' usage (mainly for libraries)
+- Source some scenarios for testing purposes (test cases)

package/{template → templates/multi-projects}/examples/default/package.json.tmpl

@@ -3,12 +3,12 @@
 	"name": "@examples/default",
 	"version": "0.0.0",
 	"scripts": {
-		"start": "node -r esbuild-register ./src/index.ts"
+		"start": "tsx ./src/index.ts"
 	},
 	"dependencies": {
 		"{{projectName}}": "workspace:^"
 	},
 	"devDependencies": {
-		"esbuild-register": "3.4.2"
+		"tsx": "4.19.1"
 	}
 }

package/templates/multi-projects/libraries/README.md

@@ -0,0 +1,3 @@
+# Libraries
+
+A collection of internal and/or publishable libraries (referred to as packages in the Node ecosystem) that are leveraged during software development to implement/share a specific aspect/functionality. A library generally encapsulates highly cohesive modules together.

package/templates/multi-projects/libraries/{{projectName}}/package.json.tmpl

@@ -0,0 +1,39 @@
+{
+	"name": "{{projectName}}",
+	"description": "{{projectDescription}}",
+	"version": "0.0.0",
+	"publishConfig": {
+		"access": "public"
+	},
+	"files": [
+		"dist"
+	],
+	"sideEffects": false,
+	"type": "module",
+	"exports": {
+		".": {
+			"source": "./src/index.ts",
+			"types": "./dist/index.d.ts",
+			"require": "./dist/index.cjs",
+			"import": "./dist/index.mjs",
+			"default": "./dist/index.mjs"
+		}
+	},
+	"license": "MIT",
+	"author": "Ayoub Adib <adbayb@gmail.com> (https://twitter.com/adbayb)",
+	"bugs": "https://github.com/{{repoId}}/issues",
+	"homepage": "https://github.com/{{repoId}}/tree/main/{{projectName}}#readme",
+	"repository": {
+		"type": "git",
+		"url": "{{projectUrl}}",
+		"directory": "libraries/{{projectName}}"
+	},
+	"scripts": {
+		"prepublishOnly": "pnpm build",
+		"clean": "rm -rf dist",
+		"start": "pnpm watch",
+		"build": "pnpm clean && quickbundle build",
+		"watch": "quickbundle watch",
+		"test": "vitest"
+	}
+}

package/templates/multi-projects/libraries/{{projectName}}/tsconfig.json

@@ -0,0 +1,5 @@
+{
+	"extends": "../../tsconfig.json",
+	"include": ["src"],
+	"exclude": ["node_modules", "dist"]
+}

package/{template → templates/multi-projects}/package.json.tmpl

@@ -1,4 +1,5 @@
 {
+	"name": "root",
 	"private": true,
 	"version": "0.0.0",
 	"type": "module",
@@ -15,11 +16,11 @@
 		"release:version": "stack release --tag",
 		"release:publish": "stack release --publish"
 	},
-	"prettier": "@adbayb/prettier-config",
+	"prettier": "@adbayb/stack/prettier",
 	"packageManager": "pnpm@{{npmVersion}}",
 	"engines": {
-		"node": ">=18.0.0",
-		"pnpm": ">=8.0.0",
+		"node": ">=22.0.0",
+		"pnpm": ">=9.0.0",
 		"npm": "please-use-pnpm",
 		"yarn": "please-use-pnpm"
 	}

package/{template → templates/multi-projects}/pnpm-workspace.yaml.tmpl

@@ -3,4 +3,3 @@ packages:
     - "examples/*"
     - "libraries/*"
     - "tools/*"
-    - "{{projectName}}"

package/{template → templates/multi-projects}/tools/README.md

@@ -1,6 +1,6 @@
 # Tools
 
 > [!note]
-> Optional folder that can be removed if no internal scripts or packages for development purposes
+> Optional folder that can be removed if no internal scripts or packages for development purposes.
 
 A collection of internal packages and scripts that act locally on the repository codebase.

package/templates/multi-projects/tsconfig.json

@@ -0,0 +1,4 @@
+{
+	"extends": "@adbayb/stack/typescript",
+	"exclude": ["node_modules", "**/node_modules", "**/dist"]
+}

package/{template → templates/multi-projects}/turbo.json

@@ -1,8 +1,9 @@
 {
 	"$schema": "https://turborepo.org/schema.json",
-	"pipeline": {
+	"tasks": {
 		"build": {
 			"dependsOn": ["^build"],
+			"cache": true,
 			"outputs": ["dist/**"]
 		},
 		"start": {

package/templates/single-project/.changeset/README.md

@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

package/templates/single-project/.changeset/config.json.tmpl

@@ -0,0 +1,13 @@
+{
+	"$schema": "https://raw.githubusercontent.com/changesets/changesets/main/packages/config/schema.json",
+	"access": "public",
+	"baseBranch": "main",
+	"changelog": ["@changesets/changelog-github", { "repo": "{{repoId}}" }],
+	"commit": false,
+	"ignore": ["@examples/*"],
+	"updateInternalDependencies": "patch",
+	"___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH": {
+		"onlyUpdatePeerDependentsWhenOutOfRange": true,
+		"updateInternalDependents": "out-of-range"
+	}
+}

package/templates/single-project/.changeset/welcome.md.tmpl

@@ -0,0 +1,5 @@
+---
+"{{projectName}}": minor
+---
+
+v0.1.0 release 🚀

package/templates/single-project/.editorconfig

@@ -0,0 +1,4 @@
+root = true
+
+[*]
+indent_size = 2

package/templates/single-project/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,34 @@
+---
+name: "🐛 Bug Report"
+about: Report a reproducible bug or regression.
+title: "Bug: "
+labels: ["bug", "triage"]
+---
+
+## Description
+
+<!--
+  Please provide a clear and concise description of what the bug is with the current and expected behavior(s). Include
+  screenshots if needed. Please test using the latest version of the relevant package to make sure your issue has not already been fixed.
+-->
+
+## Reproduction
+
+<!--
+  Issues without reproduction steps or code examples may be immediately closed as not actionable. Your bug will get fixed much faster if we can run your code. You may provide a screenshot of the application if you think it is relevant to your bug report. Here are some tips for providing a minimal example: https://stackoverflow.com/help/mcve.
+-->
+
+## Environment
+
+<!--
+  Please provide the environment you discovered this bug in.
+  It must include following informations:
+    - OS [eg. Android, iOS, mac OS, Windows, ...]
+    - Browser [eg. Chrome@110, Safari@16, ...]
+-->
+
+## Additional context
+
+<!--
+  Add any other context about the problem (eg. issue URL, related issues, documentation, etc...)
+-->

package/templates/single-project/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,4 @@
+blank_issues_enabled: false
+contact_links:
+  - name: 🤔 Questions and Help
+    about: Issues are dedicated to bugs, if you have any question, please use the dedicated GitHub discussion category.

package/templates/single-project/.github/PULL_REQUEST_TEMPLATE.md.tmpl

@@ -0,0 +1,29 @@
+<!--
+  Thanks for submitting a pull request!
+  We appreciate you spending the time to work on these changes. Before requesting reviews, please make sure that:
+
+  1. Your contribution follows coding conventions
+  2. Some valuable tests have been added
+  3. For non-internal change, a changelog entry is added
+
+  Learn more about contributing [here](https://github.com/{{repoId}}/blob/main/CONTRIBUTING.md)
+-->
+
+## Description
+
+Please include a concise summary of the change with the relevant context and main highlights:
+
+-   [ ] What I've done 1
+-   [ ] What I've done 2...
+
+## Screenshots
+
+| Before | After |
+| ------ | ----- |
+| Image  | Image |
+
+## Resources
+
+-   Issue (GitHub, ...)
+-   Specification (ADRs, RFCs, ...)
+-   ...