@adbayb/stack 1.16.1 → 2.1.0

package/templates/single-project/.github/renovate.json

@@ -0,0 +1,69 @@
+{
+	"$schema": "https://docs.renovatebot.com/renovate-schema.json",
+	"extends": [
+		":automergeAll",
+		":automergePr",
+		":automergeRequireAllStatusChecks",
+		":enableVulnerabilityAlerts",
+		":label(dependencies)",
+		":maintainLockFilesMonthly",
+		":prConcurrentLimit10",
+		":rebaseStalePrs",
+		":semanticCommits",
+		":semanticCommitScopeDisabled",
+		":semanticPrefixFixDepsChoreOthers",
+		":timezone(Europe/Paris)",
+		"npm:unpublishSafe",
+		"replacements:all",
+		"schedule:monthly",
+		"workarounds:all"
+	],
+	"commitBodyTable": true,
+	"platformAutomerge": false,
+	"ignoreDeps": [],
+	"packageRules": [
+		{
+			"matchPackagePatterns": ["*"],
+			"rangeStrategy": "auto"
+		},
+		{
+			"matchDepTypes": ["devDependencies"],
+			"rangeStrategy": "pin"
+		},
+		{
+			"matchDepTypes": ["dependencies"],
+			"rangeStrategy": "bump"
+		},
+		{
+			"description": "Synchronize CircleCI Docker image version with the Node.js one",
+			"matchPackageNames": ["cimg/node"],
+			"versioning": "node"
+		},
+		{
+			"groupName": "package dependencies",
+			"matchManagers": ["npm"],
+			"matchDepTypes": [
+				"dependencies",
+				"devDependencies",
+				"optionalDependencies",
+				"peerDependencies"
+			]
+		},
+		{
+			"groupName": "infrastructure dependencies",
+			"matchManagers": [
+				"circleci",
+				"github-actions",
+				"dockerfile",
+				"terraform",
+				"terraform-version",
+				"docker-compose",
+				"kubernetes"
+			]
+		},
+		{
+			"groupName": "engine dependencies",
+			"matchPackagePatterns": ["node", "pnpm"]
+		}
+	]
+}

package/templates/single-project/.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/single-project/.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/single-project/.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/single-project/.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/single-project/.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/templates/single-project/.gitignore.tmpl

@@ -0,0 +1,134 @@
+# 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
+.cache
+
+# 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.*
+
+# Others
+.DS_Store
+.turbo

package/templates/single-project/.npmrc.tmpl

@@ -0,0 +1,8 @@
+save-exact=true
+public-hoist-pattern[]=*changesets*
+public-hoist-pattern[]=*commitlint*
+public-hoist-pattern[]=*eslint*
+public-hoist-pattern[]=*prettier*
+public-hoist-pattern[]=*turbo*
+public-hoist-pattern[]=*typescript*
+public-hoist-pattern[]=*types*

package/templates/single-project/.nvmrc.tmpl

@@ -0,0 +1 @@
+{{nodeVersion}}

package/templates/single-project/.vscode/extensions.json

@@ -0,0 +1,8 @@
+{
+	"recommendations": [
+		"dbaeumer.vscode-eslint",
+		"unifiedjs.vscode-mdx",
+		"yoavbls.pretty-ts-errors",
+		"znck.grammarly"
+	]
+}

package/templates/single-project/.vscode/settings.json

@@ -0,0 +1,27 @@
+{
+	"eslint.validate": [
+		"javascript",
+		"javascriptreact",
+		"typescript",
+		"typescriptreact",
+		"markdown",
+		"mdx",
+		"astro"
+	],
+	"editor.codeActionsOnSave": {
+		"source.fixAll.eslint": "explicit"
+	},
+	"workbench.editor.labelFormat": "short",
+	"typescript.tsdk": "node_modules/typescript/lib",
+	"typescript.enablePromptUseWorkspaceTsdk": true,
+	"grammarly.selectors": [
+		{
+			"language": "mdx",
+			"scheme": "file"
+		},
+		{
+			"language": "md",
+			"scheme": "file"
+		}
+	]
+}

package/templates/single-project/CONTRIBUTING.md.tmpl

@@ -0,0 +1,21 @@
+# Contributing
+
+Thanks for showing interest to contribute to `{{projectName}}` 🥳.
+We are open to contributions, we look forward to improving it with your help!
+
+Here you will find guidelines that will help you to know how to contribute to this repository.
+It can be about reporting an issue, proposing a bug fix, adding some features, and even more...
+
+## 🥇 Your first contribution
+
+TODO
+
+## 🗂️ Conventions
+
+TODO
+
+## 👨‍🍳 Recipes
+
+### How to XXX?
+
+TODO

package/templates/single-project/LICENSE.tmpl

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) {{licenseYear}} Ayoub Adib
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/templates/single-project/eslint.config.js.tmpl

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

package/templates/single-project/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/templates/single-project/examples/default/package.json.tmpl

@@ -0,0 +1,14 @@
+{
+	"private": true,
+	"name": "@examples/default",
+	"version": "0.0.0",
+	"scripts": {
+		"start": "tsx ./src/index.ts"
+	},
+	"dependencies": {
+		"{{projectName}}": "workspace:^"
+	},
+	"devDependencies": {
+		"tsx": "4.19.1"
+	}
+}

package/templates/single-project/examples/default/src/index.ts.tmpl

@@ -0,0 +1,3 @@
+import { HELLO_WORLD } from "{{projectName}}";
+
+console.log(HELLO_WORLD);

package/templates/single-project/examples/default/tsconfig.json

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

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

@@ -0,0 +1,27 @@
+{
+	"name": "root",
+	"private": true,
+	"version": "0.0.0",
+	"type": "module",
+	"scripts": {
+		"prepare": "stack install",
+		"clean": "stack clean",
+		"check": "stack check",
+		"fix": "stack fix",
+		"start": "stack start",
+		"build": "stack build",
+		"watch": "stack watch",
+		"test": "stack test",
+		"release:log": "stack release --log",
+		"release:version": "stack release --tag",
+		"release:publish": "stack release --publish"
+	},
+	"prettier": "@adbayb/stack/prettier",
+	"packageManager": "pnpm@{{npmVersion}}",
+	"engines": {
+		"node": ">=22.0.0",
+		"pnpm": ">=9.0.0",
+		"npm": "please-use-pnpm",
+		"yarn": "please-use-pnpm"
+	}
+}

package/templates/single-project/pnpm-workspace.yaml.tmpl

@@ -0,0 +1,4 @@
+packages:
+    - "examples/*"
+    - "tools/*"
+    - "{{projectName}}"

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

@@ -0,0 +1,6 @@
+# Tools
+
+> [!note]
+> 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/single-project/tsconfig.json

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

package/templates/single-project/turbo.json

@@ -0,0 +1,25 @@
+{
+	"$schema": "https://turborepo.org/schema.json",
+	"tasks": {
+		"build": {
+			"dependsOn": ["^build"],
+			"cache": true,
+			"outputs": ["dist/**"]
+		},
+		"start": {
+			"dependsOn": ["build"],
+			"cache": false,
+			"persistent": true
+		},
+		"watch": {
+			"dependsOn": ["^build"],
+			"cache": false,
+			"persistent": true
+		},
+		"test": {
+			"dependsOn": ["build"],
+			"cache": false,
+			"persistent": true
+		}
+	}
+}