@mrcointreau/shared-config 0.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 mrcointreau
+
+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/README.md

@@ -0,0 +1,267 @@
+# @mrcointreau/shared-config
+
+Reusable GitHub Actions workflows and shared configurations for Node.js and Python projects.
+
+[![CI](https://github.com/mrcointreau/shared-config/workflows/CI/badge.svg)](https://github.com/mrcointreau/shared-config/actions)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+## Overview
+
+This repository provides a collection of reusable GitHub Actions and shared configurations to standardize CI/CD pipelines across Node.js and Python projects. It includes actions for continuous integration, semantic releases, documentation generation, and common utilities.
+
+The shared configurations package also exports ESLint and Prettier configurations for TypeScript projects, ensuring consistent code style across your repositories.
+
+## Features
+
+- **CI Actions** - Audit, lint, test, and build for Node.js and Python
+- **Release Actions** - Semantic versioning and publishing to npm/PyPI with OIDC support
+- **Documentation Actions** - Generate and publish docs with TypeDoc, Sphinx, and GitHub Pages
+- **Utility Actions** - Commit linting and GitHub App token generation
+- **Shared Configs** - ESLint and Prettier configurations for TypeScript
+
+## Installation
+
+### Prerequisites
+
+- Node.js >= 22 (for Node.js actions)
+- Python >= 3.12 (for Python actions)
+- npm or uv package manager
+
+### Install Shared Configurations
+
+```bash
+npm install @mrcointreau/shared-config --save-dev
+```
+
+## Quick Start
+
+Use an action in your GitHub workflow:
+
+```yaml
+- uses: mrcointreau/shared-config/actions/ci/node@main
+```
+
+## Usage
+
+### CI Actions
+
+#### Node.js CI
+
+Audit, lint, test, and build Node.js projects using npm.
+
+```yaml
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: mrcointreau/shared-config/actions/ci/node@main
+        with:
+          node-version: "22"
+          # skip-audit: "true"
+          # skip-lint: "true"
+          # skip-test: "true"
+          # skip-build: "true"
+```
+
+#### Python CI
+
+Audit, lint, test, and build Python projects using uv.
+
+```yaml
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: mrcointreau/shared-config/actions/ci/python@main
+        with:
+          python-version: "3.12"
+          # skip-audit: "true"
+          # skip-lint: "true"
+          # skip-test: "true"
+          # skip-build: "true"
+```
+
+### Release Actions
+
+The release actions use [semantic-release](https://semantic-release.gitbook.io/) with a branch-based strategy:
+
+| Branch | Release Type | Example Version |
+|--------|--------------|-----------------|
+| `main` | Stable | `1.0.0` |
+| `beta` | Prerelease | `1.0.0-beta.1` |
+
+**Recommended workflow:**
+1. Push to `beta` branch → automatically publishes beta/prerelease versions
+2. Merge `beta` into `main` → automatically publishes stable versions
+
+#### Node.js Release
+
+Publish Node.js packages to npm with semantic-release and OIDC provenance.
+
+```yaml
+on:
+  push:
+    branches: [main, beta]  # Triggers on both branches
+  workflow_dispatch:        # Optional: manual trigger
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: mrcointreau/shared-config/actions/release/node@main
+        with:
+          bot-token: ${{ secrets.BOT_TOKEN }}
+          npm-token: ${{ secrets.NPM_TOKEN }}
+          release-type: "beta"  # Uses config with both main and beta branches
+          # use-oidc: "true"
+          # dry-run: "false"
+```
+
+#### Python Release
+
+Publish Python packages to PyPI with semantic-release and OIDC Trusted Publishing.
+
+```yaml
+on:
+  push:
+    branches: [main, beta]  # Triggers on both branches
+  workflow_dispatch:        # Optional: manual trigger
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: mrcointreau/shared-config/actions/release/python@main
+        with:
+          bot-token: ${{ secrets.BOT_TOKEN }}
+          release-type: "beta"  # Uses config with both main and beta branches
+          # use-oidc: "true"
+          # pypi-token: ${{ secrets.PYPI_TOKEN }}  # if not using OIDC
+          # dry-run: "false"
+```
+
+### Documentation Actions
+
+#### TypeDoc
+
+Generate TypeScript documentation with TypeDoc.
+
+```yaml
+- uses: mrcointreau/shared-config/actions/docs/typedoc@main
+  with:
+    docs-path: "docs"
+    entry-points: "src/index.ts"
+    # config-path: "typedoc.json"
+```
+
+#### Sphinx
+
+Generate Python documentation with Sphinx.
+
+```yaml
+- uses: mrcointreau/shared-config/actions/docs/sphinx@main
+  with:
+    docs-directory: "docs"
+    docs-path: "docs/_build/html"
+    # dependency-groups: "docs"
+```
+
+#### Publish to GitHub Pages
+
+```yaml
+- uses: mrcointreau/shared-config/actions/docs/publish@main
+  with:
+    docs-path: "docs"
+    github-token: ${{ secrets.GITHUB_TOKEN }}
+```
+
+### Utility Actions
+
+#### Commit Lint
+
+Lint commits using conventional commit rules.
+
+```yaml
+- uses: mrcointreau/shared-config/actions/utils/commitlint@main
+  with:
+    from: ${{ github.event.pull_request.base.sha }}
+    to: ${{ github.event.pull_request.head.sha }}
+```
+
+#### Bot Token
+
+Generate a GitHub App installation token for automated operations.
+
+```yaml
+- uses: mrcointreau/shared-config/actions/utils/bot-token@main
+  id: bot-token
+  with:
+    app-id: ${{ secrets.APP_ID }}
+    private-key: ${{ secrets.APP_PRIVATE_KEY }}
+# Use with: ${{ steps.bot-token.outputs.token }}
+```
+
+### Shared Configurations
+
+#### ESLint
+
+Uses TypeScript-ESLint recommended rules, unused imports detection, and Prettier integration.
+
+```javascript
+// eslint.config.mjs
+import config from '@mrcointreau/shared-config/eslint'
+
+export default config
+```
+
+#### Prettier
+
+Single quotes, no semicolons, 140 char line width, trailing commas.
+
+```javascript
+// prettier.config.cjs
+module.exports = require('@mrcointreau/shared-config/prettier')
+```
+
+## Configuration
+
+### Release Action Options
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `release-type` | string | `"beta"` | Config to use: `beta` (includes beta branch) or `stable` (main only) |
+| `dry-run` | string | `"false"` | Run without publishing |
+| `use-oidc` | string | `"true"` | Use OIDC for secure publishing |
+| `config-path` | string | `""` | Custom semantic-release config path |
+
+### CI Action Options
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `skip-audit` | string | `"false"` | Skip security audit step |
+| `skip-lint` | string | `"false"` | Skip linting step |
+| `skip-test` | string | `"false"` | Skip test step |
+| `skip-build` | string | `"false"` | Skip build step |
+| `pre-test-script` | string | `""` | Script to run before tests |
+
+## Contributing
+
+Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

package/configs/eslint.config.mjs

@@ -0,0 +1,58 @@
+/**
+ * Shared ESLint configuration for TypeScript projects.
+ * Uses TypeScript-ESLint recommended rules, unused imports detection,
+ * and Prettier integration.
+ */
+import eslint from '@eslint/js'
+import prettier from 'eslint-config-prettier'
+import unusedImports from 'eslint-plugin-unused-imports'
+import tseslint from 'typescript-eslint'
+
+export default tseslint.config(
+  {
+    ignores: [
+      '.eslintrc.js',
+      'node_modules/**',
+      'dist/**',
+      'build/**',
+      'coverage/**',
+      '**/generated/**',
+      '.idea/**',
+      '.vscode/**',
+    ],
+  },
+  eslint.configs.recommended,
+  tseslint.configs.recommended,
+  {
+    files: ['**/*.ts'],
+    plugins: {
+      'unused-imports': unusedImports,
+    },
+    languageOptions: {
+      parser: tseslint.parser,
+      parserOptions: {
+        projectService: true,
+        ecmaVersion: 'latest',
+        sourceType: 'module',
+      },
+    },
+    rules: {
+      'no-console': 'warn',
+      '@typescript-eslint/no-unused-vars': 'off',
+      'unused-imports/no-unused-imports': 'error',
+      'unused-imports/no-unused-vars': [
+        'warn',
+        { ignoreRestSiblings: true, argsIgnorePattern: '^_', varsIgnorePattern: '^_' },
+      ],
+      '@typescript-eslint/no-unused-expressions': 'off',
+      'prefer-template': 'error',
+    },
+  },
+  {
+    files: ['**/*.spec.ts', '**/*.test.ts'],
+    rules: {
+      'no-restricted-syntax': 'off',
+    },
+  },
+  prettier,
+)

package/configs/prettier.config.cjs

@@ -0,0 +1,14 @@
+/**
+ * Shared Prettier configuration.
+ * Single quotes, no semicolons, 140 char line width, trailing commas.
+ */
+module.exports = {
+  singleQuote: true,
+  jsxSingleQuote: false,
+  semi: false,
+  tabWidth: 2,
+  trailingComma: 'all',
+  printWidth: 140,
+  endOfLine: 'lf',
+  arrowParens: 'always',
+}

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@mrcointreau/shared-config",
+  "version": "0.0.2",
+  "description": "Reusable GitHub Actions workflows and shared configurations for Node.js and Python projects",
+  "author": "mrcointreau",
+  "license": "MIT",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mrcointreau/shared-config.git"
+  },
+  "bugs": {
+    "url": "https://github.com/mrcointreau/shared-config/issues"
+  },
+  "homepage": "https://github.com/mrcointreau/shared-config#readme",
+  "keywords": [
+    "github-actions",
+    "ci-cd",
+    "eslint",
+    "prettier",
+    "shared-config",
+    "reusable-workflows"
+  ],
+  "exports": {
+    "./eslint": "./configs/eslint.config.mjs",
+    "./prettier": "./configs/prettier.config.cjs"
+  },
+  "files": [
+    "configs"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "@eslint/js": ">=9",
+    "eslint": ">=9",
+    "eslint-config-prettier": ">=9",
+    "eslint-plugin-unused-imports": ">=4",
+    "prettier": ">=3",
+    "typescript-eslint": ">=8"
+  }
+}