@mrshmllw/campfire 0.0.0 → 1.0.0-crumbs-feature-adding-some-default-configs.2

package/.github/workflows/bump_and_publish.yml

@@ -1,30 +1,52 @@
 name: Bump and Publish
 
-on: 
+on:
   workflow_dispatch:
 
 permissions:
-  contents: write 
+  contents: write
 
 jobs:
   bump-and-publish:
     runs-on: ubuntu-latest
     steps:
+      - name: Check branch 🪵
+        run: |
+          # Ensure the branch is either:
+          # - main
+          # OR
+          # - feature/your-branch-name
+          # - fix/your-branch-name
+          # - chore/your-branch-name
+          if [[ "$GITHUB_REF" != "refs/heads/main" && ! "$GITHUB_REF" =~ ^refs/heads/(feature|fix|chore)/.* ]]; then
+            echo "This job can only run on the 'main' branch or a '(feature|fix|chore)/*' branch."
+            exit 1
+          fi
+        shell: bash
+      - name: Generate Token 🔐
+        uses: actions/create-github-app-token@v1
+        id: app-token
+        with:
+          app-id: ${{ vars.MARSHMALLOW_CI_APP_ID }}
+          private-key: ${{ secrets.MARSHMALLOW_CI_APP_PRIVATE_KEY }}
       - name: Checkout 🛎️
         uses: actions/checkout@v4
         with:
+          token: ${{ steps.app-token.outputs.token }}
           persist-credentials: false
-
       - name: Setup Node 👾
         uses: actions/setup-node@v4
         with:
-          node-version: '20'
-
+          node-version-file: ".nvmrc"
       - name: Install Dependencies 🔧
         run: |
           npm ci
+      - name: Configure Git 🪪
+        run: |
+          git config user.name "marshmallow-ci"
+          git config user.email "ci@marshmallow.co"
       - name: Generate CHANGELOG.md & Bump & Release to NPM 🦫
         env:
-          GITHUB_TOKEN: ${{ secrets.MARSHMALLOW_CI_PAT }}
+          GITHUB_TOKEN: ${{ steps.app-token.outputs.token }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
         run: npx semantic-release

package/.github/workflows/preview_bump_and_publish.yml

@@ -1,30 +1,39 @@
 name: Preview Bump and Publish
 
-on: 
+on:
   workflow_dispatch:
 
 permissions:
-  contents: write 
+  contents: write
 
 jobs:
   preview-bump-and-publish:
     runs-on: ubuntu-latest
     steps:
+      - name: Generate Token 🔐
+        uses: actions/create-github-app-token@v1
+        id: app-token
+        with:
+          app-id: ${{ vars.MARSHMALLOW_CI_APP_ID }}
+          private-key: ${{ secrets.MARSHMALLOW_CI_APP_PRIVATE_KEY }}
       - name: Checkout 🛎️
         uses: actions/checkout@v4
         with:
+          token: ${{ steps.app-token.outputs.token }}
           persist-credentials: false
-
       - name: Setup Node 👾
         uses: actions/setup-node@v4
         with:
-          node-version: '20'
-
+          node-version-file: ".nvmrc"
       - name: Install Dependencies 🔧
         run: |
           npm ci
+      - name: Configure Git 🪪
+        run: |
+          git config user.name "marshmallow-ci"
+          git config user.email "ci@marshmallow.co"
       - name: Generate preview CHANGELOG.md
         env:
-          GITHUB_TOKEN: ${{ secrets.MARSHMALLOW_CI_PAT }}
+          GITHUB_TOKEN: ${{ steps.app-token.outputs.token }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
         run: npx semantic-release --dry-run

package/.husky/commit-msg

@@ -0,0 +1 @@
+npx --no -- commitlint --edit $1

package/.husky/pre-commit

@@ -0,0 +1 @@
+npm run pre-commit-lint

package/.nvmrc

@@ -0,0 +1 @@
+20.11.0

package/.prettierignore

@@ -0,0 +1,5 @@
+node_modules
+dist
+build
+README.md
+.github

package/commitlint.config.ts

@@ -0,0 +1,2 @@
+import config from './libs/configs/commitlint.config'
+export default config

package/dist/configs/commitlint.config.js

@@ -0,0 +1,32 @@
+import { RuleConfigSeverity } from '@commitlint/types';
+export const config = {
+    parserPreset: 'conventional-changelog-conventionalcommits',
+    ignores: [
+        (commit) => commit.startsWith('BREAKING CHANGE:'),
+        (commit) => commit.startsWith('BREAKING CHANGES:'),
+        (commit) => commit.startsWith('BREAKING-CHANGE:'),
+        (commit) => commit.startsWith('BREAKING-CHANGES:'),
+    ],
+    rules: {
+        'type-case': [RuleConfigSeverity.Error, 'always', 'lower-case'],
+        'type-empty': [RuleConfigSeverity.Error, 'never'],
+        'type-enum': [
+            RuleConfigSeverity.Error,
+            'always',
+            [
+                'feat',
+                'fix',
+                'docs',
+                'bump',
+                'dependabot',
+                'refactor',
+                'style',
+                'perf',
+                'test',
+                'revert',
+                'chore',
+            ],
+        ],
+    },
+};
+export default config;

package/dist/configs/eslint.config.js

@@ -0,0 +1,29 @@
+import typescriptEslintPlugin from '@typescript-eslint/eslint-plugin';
+import tsParser from '@typescript-eslint/parser';
+import eslintPluginPrettierRecommended from 'eslint-plugin-prettier/recommended';
+const config = [
+    eslintPluginPrettierRecommended,
+    {
+        ignores: ['node_modules', 'dist', 'build'],
+    },
+    {
+        files: ['**/*.+(ts|tsx)'],
+        languageOptions: {
+            parser: tsParser,
+        },
+        plugins: {
+            '@typescript-eslint': typescriptEslintPlugin,
+        },
+        rules: {
+            '@typescript-eslint/no-explicit-any': 'warn', // Warns on use of 'any'
+            '@typescript-eslint/explicit-function-return-type': 'off', // Disables return type enforcement
+            '@typescript-eslint/no-unused-vars': [
+                'warn',
+                { argsIgnorePattern: '^_' },
+            ],
+            'no-console': 'warn', // Warns on console.log and similar calls
+            strict: ['error', 'never'],
+        },
+    },
+];
+export default config;

package/dist/configs/lint-staged.config.js

@@ -0,0 +1,5 @@
+const config = {
+    '*.+(js|ts|tsx)': ['eslint'],
+    '**/*.+(js|json|ts|tsx)': ['prettier --write'],
+};
+export default config;

package/dist/configs/prettier.config.js

@@ -0,0 +1,8 @@
+const config = {
+    bracketSpacing: true,
+    proseWrap: 'always',
+    semi: false,
+    singleQuote: true,
+    trailingComma: 'all',
+};
+export default config;

package/dist/configs/release.config.js

@@ -0,0 +1,119 @@
+import { readFileSync } from 'fs';
+import path from 'path';
+const branch = process.env.GITHUB_REF_NAME;
+/**
+ * Attempt to determine the repository URL.
+ * By loading it from the consumer project's package.json.
+ * If the URL starts with 'git+', remove that prefix.
+ */
+function getRepositoryUrl() {
+    try {
+        // process.cwd() will point to the consumer repo when semantic-release runs
+        const packageJsonPath = path.join(process.cwd(), 'package.json');
+        const packageJson = readFileSync(packageJsonPath, 'utf8');
+        const pkg = JSON.parse(packageJson);
+        if (pkg.repository) {
+            let url = typeof pkg.repository === 'object' ? pkg.repository.url : pkg.repository;
+            // Remove "git+" prefix if it exists
+            if (typeof url === 'string' && url.startsWith('git+')) {
+                url = url.slice(4);
+            }
+            return url;
+        }
+    }
+    catch (err) {
+        console.warn('Unable to load repository URL from package.json:', err);
+    }
+    return undefined;
+}
+const repositoryUrl = getRepositoryUrl();
+/**
+ * @type {import('semantic-release').GlobalConfig}
+ */
+const config = {
+    branches: [
+        'main',
+        {
+            name: '(feature|fix|chore)/*',
+            // The prerelease name uses a dynamic expression to replace '/' with '-'
+            prerelease: 'crumbs-${name.replace(/\\//g, "-")}',
+        },
+    ],
+    repositoryUrl,
+    plugins: [
+        [
+            '@semantic-release/commit-analyzer',
+            {
+                preset: 'angular',
+                releaseRules: [
+                    { type: 'feat', release: 'minor' },
+                    { type: 'fix', release: 'patch' },
+                    { type: 'docs', release: 'patch' },
+                    { type: 'bump', release: 'patch' },
+                    { type: 'dependabot', release: 'patch' },
+                    { type: 'style', release: 'patch' },
+                    { type: 'refactor', release: 'patch' },
+                    { type: 'perf', release: 'patch' },
+                    { type: 'test', release: 'patch' },
+                    { type: 'revert', release: 'patch' },
+                    { type: 'chore', release: 'patch' },
+                ],
+                parserOpts: {
+                    noteKeywords: [
+                        'BREAKING CHANGE',
+                        'BREAKING-CHANGE',
+                        'BREAKING CHANGES',
+                        'BREAKING-CHANGES',
+                    ],
+                },
+            },
+        ],
+        [
+            '@semantic-release/release-notes-generator',
+            {
+                preset: 'conventionalcommits',
+                presetConfig: {
+                    types: [
+                        { type: 'feat', section: 'Features' },
+                        { type: 'fix', section: 'Bug Fixes' },
+                        { type: 'docs', section: 'Documentation' },
+                        { type: 'bump', hidden: true },
+                        { type: 'dependabot', hidden: true },
+                        { type: 'style', section: 'Styles' },
+                        { type: 'refactor', section: 'Refactors' },
+                        { type: 'perf', section: 'Performance Improvements' },
+                        { type: 'test', section: 'Tests' },
+                        { type: 'revert', hidden: true },
+                        { type: 'chore', hidden: true },
+                        { type: '*', section: 'Others' },
+                    ],
+                },
+            },
+        ],
+        [
+            '@semantic-release/github',
+            {
+                assets: ['dist'],
+            },
+        ],
+        [
+            '@semantic-release/npm',
+            {
+                npmPublish: true,
+                pkgRoot: '.',
+            },
+        ],
+    ],
+};
+// Only add the changelog and git plugins on release (not for prereleases)
+const isPrereleaseBranch = config.branches.some((b) => typeof b === 'object' && branch !== 'main' && b.prerelease);
+if (!isPrereleaseBranch) {
+    config.plugins.push('@semantic-release/changelog', [
+        '@semantic-release/git',
+        {
+            assets: ['package.json', 'package-lock.json', 'CHANGELOG.md'],
+            message: 'chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}',
+        },
+    ]);
+}
+export default config;

package/eslint.config.js

@@ -0,0 +1,2 @@
+import config from './libs/configs/eslint.config.js'
+export default config

package/libs/configs/commitlint.config.ts

@@ -0,0 +1,34 @@
+import { RuleConfigSeverity, UserConfig } from '@commitlint/types'
+
+export const config: UserConfig = {
+  parserPreset: 'conventional-changelog-conventionalcommits',
+  ignores: [
+    (commit: string) => commit.startsWith('BREAKING CHANGE:'),
+    (commit: string) => commit.startsWith('BREAKING CHANGES:'),
+    (commit: string) => commit.startsWith('BREAKING-CHANGE:'),
+    (commit: string) => commit.startsWith('BREAKING-CHANGES:'),
+  ],
+  rules: {
+    'type-case': [RuleConfigSeverity.Error, 'always', 'lower-case'],
+    'type-empty': [RuleConfigSeverity.Error, 'never'],
+    'type-enum': [
+      RuleConfigSeverity.Error,
+      'always',
+      [
+        'feat',
+        'fix',
+        'docs',
+        'bump',
+        'dependabot',
+        'refactor',
+        'style',
+        'perf',
+        'test',
+        'revert',
+        'chore',
+      ],
+    ],
+  },
+}
+
+export default config

package/libs/configs/eslint.config.js

@@ -0,0 +1,30 @@
+import typescriptEslintPlugin from '@typescript-eslint/eslint-plugin'
+import tsParser from '@typescript-eslint/parser'
+import eslintPluginPrettierRecommended from 'eslint-plugin-prettier/recommended'
+
+const config = [
+  eslintPluginPrettierRecommended,
+  {
+    ignores: ['node_modules', 'dist', 'build'],
+  },
+  {
+    files: ['**/*.+(ts|tsx)'],
+    languageOptions: {
+      parser: tsParser,
+    },
+    plugins: {
+      '@typescript-eslint': typescriptEslintPlugin,
+    },
+    rules: {
+      '@typescript-eslint/no-explicit-any': 'warn', // Warns on use of 'any'
+      '@typescript-eslint/explicit-function-return-type': 'off', // Disables return type enforcement
+      '@typescript-eslint/no-unused-vars': [
+        'warn',
+        { argsIgnorePattern: '^_' },
+      ],
+      'no-console': 'warn', // Warns on console.log and similar calls
+      strict: ['error', 'never'],
+    },
+  },
+]
+export default config

package/libs/configs/lint-staged.config.js

@@ -0,0 +1,6 @@
+const config = {
+  '*.+(js|ts|tsx)': ['eslint'],
+  '**/*.+(js|json|ts|tsx)': ['prettier --write'],
+}
+
+export default config

package/libs/configs/prettier.config.js

@@ -0,0 +1,9 @@
+const config = {
+  bracketSpacing: true,
+  proseWrap: 'always',
+  semi: false,
+  singleQuote: true,
+  trailingComma: 'all',
+}
+
+export default config

package/libs/configs/release.config.js

@@ -0,0 +1,131 @@
+import { readFileSync } from 'fs'
+import path from 'path'
+
+const branch = process.env.GITHUB_REF_NAME
+
+/**
+ * Attempt to determine the repository URL.
+ * By loading it from the consumer project's package.json.
+ * If the URL starts with 'git+', remove that prefix.
+ */
+function getRepositoryUrl() {
+  try {
+    // process.cwd() will point to the consumer repo when semantic-release runs
+    const packageJsonPath = path.join(process.cwd(), 'package.json')
+    const packageJson = readFileSync(packageJsonPath, 'utf8')
+    const pkg = JSON.parse(packageJson)
+
+    if (pkg.repository) {
+      let url =
+        typeof pkg.repository === 'object' ? pkg.repository.url : pkg.repository
+
+      // Remove "git+" prefix if it exists
+      if (typeof url === 'string' && url.startsWith('git+')) {
+        url = url.slice(4)
+      }
+      return url
+    }
+  } catch (err) {
+    console.warn('Unable to load repository URL from package.json:', err)
+  }
+  return undefined
+}
+
+const repositoryUrl = getRepositoryUrl()
+
+/**
+ * @type {import('semantic-release').GlobalConfig}
+ */
+const config = {
+  branches: [
+    'main',
+    {
+      name: '(feature|fix|chore)/*',
+      // The prerelease name uses a dynamic expression to replace '/' with '-'
+      prerelease: 'crumbs-${name.replace(/\\//g, "-")}',
+    },
+  ],
+  repositoryUrl,
+  plugins: [
+    [
+      '@semantic-release/commit-analyzer',
+      {
+        preset: 'angular',
+        releaseRules: [
+          { type: 'feat', release: 'minor' },
+          { type: 'fix', release: 'patch' },
+          { type: 'docs', release: 'patch' },
+          { type: 'bump', release: 'patch' },
+          { type: 'dependabot', release: 'patch' },
+          { type: 'style', release: 'patch' },
+          { type: 'refactor', release: 'patch' },
+          { type: 'perf', release: 'patch' },
+          { type: 'test', release: 'patch' },
+          { type: 'revert', release: 'patch' },
+          { type: 'chore', release: 'patch' },
+        ],
+        parserOpts: {
+          noteKeywords: [
+            'BREAKING CHANGE',
+            'BREAKING-CHANGE',
+            'BREAKING CHANGES',
+            'BREAKING-CHANGES',
+          ],
+        },
+      },
+    ],
+    [
+      '@semantic-release/release-notes-generator',
+      {
+        preset: 'conventionalcommits',
+        presetConfig: {
+          types: [
+            { type: 'feat', section: 'Features' },
+            { type: 'fix', section: 'Bug Fixes' },
+            { type: 'docs', section: 'Documentation' },
+            { type: 'bump', hidden: true },
+            { type: 'dependabot', hidden: true },
+            { type: 'style', section: 'Styles' },
+            { type: 'refactor', section: 'Refactors' },
+            { type: 'perf', section: 'Performance Improvements' },
+            { type: 'test', section: 'Tests' },
+            { type: 'revert', hidden: true },
+            { type: 'chore', hidden: true },
+            { type: '*', section: 'Others' },
+          ],
+        },
+      },
+    ],
+    [
+      '@semantic-release/github',
+      {
+        assets: ['dist'],
+      },
+    ],
+    [
+      '@semantic-release/npm',
+      {
+        npmPublish: true,
+        pkgRoot: '.',
+      },
+    ],
+  ],
+}
+
+// Only add the changelog and git plugins on release (not for prereleases)
+const isPrereleaseBranch = config.branches.some(
+  (b) => typeof b === 'object' && branch !== 'main' && b.prerelease,
+)
+
+if (!isPrereleaseBranch) {
+  config.plugins.push('@semantic-release/changelog', [
+    '@semantic-release/git',
+    {
+      assets: ['package.json', 'package-lock.json', 'CHANGELOG.md'],
+      message:
+        'chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}',
+    },
+  ])
+}
+
+export default config

package/lint-staged.config.js

@@ -0,0 +1,2 @@
+import config from './libs/configs/lint-staged.config.js'
+export default config

package/package.json

@@ -1,28 +1,44 @@
 {
   "name": "@mrshmllw/campfire",
-  "version": "0.0.0",
+  "version": "1.0.0-crumbs-feature-adding-some-default-configs.2",
   "description": "Collection of toasty utils and configs used by Marshmallow Technology",
   "main": "index.js",
   "type": "module",
   "scripts": {
     "clean": "rimraf ./dist",
-    "test": "echo \"Error: no test specified\" && exit 1",
+    "test": "echo \"Error: There are no tests yet\"",
     "check-types": "tsc --noEmit",
     "build": "npm run clean && tsc --p tsconfig.build.json",
-    "prepublishOnly": "npm run build"
+    "prepublishOnly": "npm run build",
+    "prepare": "husky",
+    "pre-commit-lint": "npm run check-types && lint-staged",
+    "commitlint": "commitlint --edit"
   },
   "dependencies": {
-    "typescript": "^5.6.3",
-    "micromatch": "^4.0.8"
+    "typescript": "^5.7.3"
   },
   "devDependencies": {
-    "semantic-release": "^24.2.0",
+    "@commitlint/cli": "^19.7.1",
+    "@commitlint/types": "^19.5.0",
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
     "@semantic-release/github": "^11.0.1",
     "@semantic-release/npm": "^12.0.1",
+    "@typescript-eslint/eslint-plugin": "^8.23.0",
+    "@typescript-eslint/parser": "^8.23.0",
     "conventional-changelog-conventionalcommits": "^8.0.0",
-    "rimraf": "^6.0.1"
+    "eslint": "^9.19.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.2.3",
+    "husky": "^9.1.7",
+    "lint-staged": "^15.4.3",
+    "prettier": "^3.4.2",
+    "rimraf": "^6.0.1",
+    "semantic-release": "^24.2.1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/marshmallow-insurance/campfire.git"
   },
   "author": "",
   "license": "ISC"

package/prettier.config.js

@@ -0,0 +1,2 @@
+import config from './libs/configs/prettier.config.js'
+export default config

package/release.config.js

@@ -1,116 +1,2 @@
-import micromatch from "micromatch";
-
-const branch = process.env.GITHUB_REF_NAME;
-
-/**
- * @type {import('semantic-release').GlobalConfig}
- */
-const config = {
-  branches: [
-    "main",
-    {
-      name: "(feature|fix|chore)/*",
-      prerelease: 'sticks-${name.replace(/\\//g, "-")}',
-    },
-  ],
-  tagFormat: "dev.${version}",
-  repositoryUrl: "https://github.com/marshmallow-insurance/campfire.git",
-  plugins: [
-    [
-      "@semantic-release/commit-analyzer",
-      {
-        preset: "angular",
-        releaseRules: [
-          { type: "feat", release: "minor" },
-          { type: "fix", release: "patch" },
-          { type: "docs", release: "patch" },
-          { type: "bump", release: "patch" },
-          { type: "dependabot", release: "patch" },
-          { type: "style", release: "patch" },
-          { type: "refactor", release: "patch" },
-          { type: "perf", release: "patch" },
-          { type: "test", release: "patch" },
-          { type: "revert", release: "patch" },
-          { type: "chore", release: "patch" },
-        ],
-        parserOpts: {
-          noteKeywords: [
-            "BREAKING CHANGE",
-            "BREAKING-CHANGE",
-            "BREAKING CHANGES",
-            "BREAKING-CHANGES",
-          ],
-        },
-      },
-    ],
-    [
-      "@semantic-release/release-notes-generator",
-      {
-        preset: "conventionalcommits",
-        presetConfig: {
-          types: [
-            { type: "feat", section: "Features" },
-            { type: "fix", section: "Bug Fixes" },
-            { type: "docs", section: "Documentation" },
-            { type: "bump", hidden: true },
-            { type: "dependabot", hidden: true },
-            { type: "style", section: "Styles" },
-            { type: "refactor", section: "Refactors" },
-            { type: "perf", section: "Performance Improvements" },
-            { type: "test", section: "Tests" },
-            { type: "revert", hidden: true },
-            { type: "chore", hidden: true },
-            { type: "*", section: "Others" },
-          ],
-        },
-      },
-    ],
-    [
-      "@semantic-release/github",
-      {
-        assets: ["dist"],
-      },
-    ],
-    [
-      "@semantic-release/npm",
-      {
-        npmPublish: true,
-        pkgRoot: ".",
-      },
-    ],
-  ],
-};
-
-const isAcceptedBranch = micromatch.isMatch(
-  branch,
-  config.branches.map((b) => (typeof b === "object" ? b.name : b))
-);
-
-if (!isAcceptedBranch) {
-  console.log(
-    `Branch ${branch} is not accepted for release. Skipping release.`
-  );
-  console.log(
-    `Accepted branches: ${config.branches.join(
-      ", "
-    )}. [Micromatch](https://github.com/micromatch/micromatch?tab=readme-ov-file#matching-features) is used for matching.`
-  );
-  process.exit(0);
-}
-
-const isPrereleaseBranch = config.branches.some(
-  (b) => typeof b === "object" && isAcceptedBranch && b.prerelease
-);
-
-if (!isPrereleaseBranch) {
-  config.plugins.push("@semantic-release/changelog", [
-    "@semantic-release/git",
-    {
-      assets: ["package.json", "package-lock.json", "CHANGELOG.md"],
-      message:
-        "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}",
-    },
-  ]);
-}
-
-export default config;
+import config from './libs/configs/release.config.js'
+export default config

package/tsconfig.build.json

@@ -1,6 +1,13 @@
 {
   "extends": "./tsconfig.json",
   "compilerOptions": {
-    "rootDir": "libs",
+    "rootDir": "libs"
   },
+  "exclude": [
+    "release.config.js",
+    "commitlint.config.ts",
+    "eslint.config.js",
+    "prettier.config.js",
+    "lint-staged.config.js"
+  ]
 }

package/tsconfig.json

@@ -1,17 +1,16 @@
 {
   "compilerOptions": {
     "outDir": "./dist",
-    "target": "ESNext",
-    "module": "ESNext",
+    "module": "esnext",
+    "target": "esnext",
+    "moduleResolution": "Bundler",
+    "allowJs": true,
     "esModuleInterop": true,
     "forceConsistentCasingInFileNames": true,
     "strict": true,
     "skipLibCheck": true,
-    "baseUrl": "libs",
+    "baseUrl": "libs"
   },
-  "include": [
-    "libs/**/*",
-    "release.config.js"
-  ],
+  "include": ["libs/**/*"],
   "exclude": ["node_modules", "dist"]
 }

package/dist/configs/index.js

@@ -1 +0,0 @@
-"use strict";