feat: initial release

Author: wkillerud

.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

.github/workflows/publish.yml

@@ -0,0 +1,31 @@
+name: Publish
+
+permissions:
+  contents: write # to be able to publish a GitHub release
+  issues: write # to be able to comment on released issues
+  pull-requests: write # to be able to comment on released pull requests
+  id-token: write # to enable use of OIDC for npm provenance
+
+on:
+  push:
+    branches:
+      - main
+      - next
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - run: npm install
+
+      - run: npx semantic-release
+        env:
+          SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -0,0 +1 @@
+node_modules/

.npmrc

@@ -0,0 +1,2 @@
+package-lock=false
+save-exact=true

CONTRIBUTING.md

@@ -0,0 +1,11 @@
+# Contributing
+
+Thank you for showing an interest in contributing to Podium 🧡
+
+You can find [the general contribution docs here](https://github.com/podium-lib/.github/blob/main/CONTRIBUTING.md).
+
+This module is a [shared config for TypeScript](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html#tsconfig-bases). We accept changes that should apply to all repositories in the [podium-lib origanisation](https://github.com/podium-lib).
+
+Exports from this module are handled via the `"files"` property. Configurations should be at the root level so user's `"extends"` field is `@podium/typescript-config/module.json` and so on.
+
+A change in configuration is considered a `patch` in [semantic versioning](https://semver.org/). A new export would be a `minor`. Depending on a newer major version of TypeScript would be a `major`.

README.md

@@ -0,0 +1,49 @@
+# @podium/typescript-config
+
+Shared config for TypeScript, used in Podium projects to generate type definitions from JSDoc and test them.
+
+## Install
+
+```
+npm install --save-dev typescript @podium/typescript-config
+```
+
+## Usage
+
+Create two files in your root directory.
+
+`tsconfig.json` (assuming source in `lib/`):
+
+```json
+{
+    "extends": "@podium/typescript-config/module.json",
+    "include": ["./lib/**/*.js"],
+    "compilerOptions": {
+        "outDir": "types"
+    }
+}
+```
+
+`tsconfig.test.json` (assuming tests in `tests/`):
+
+```json
+{
+    "extends": "@podium/typescript-config/test.json",
+    "include": ["./tests/**/*.js"]
+}
+```
+
+You should have a similar setup in your `package.json`:
+
+```json
+{
+    "scripts": {
+        "types": "run-s types:module types:test",
+        "types:module": "tsc",
+        "types:test": "tsc --project tsconfig.test.json"
+    },
+    "dependencies": {
+        "npm-run-all2": "6.2.3"
+    }
+}
+```

module.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "lib": ["es2020", "DOM"],
+    "module": "nodenext",
+    "moduleResolution": "nodenext",
+    "target": "es2020",
+    "resolveJsonModule": true,
+    "checkJs": true,
+    "allowJs": true,
+    "declaration": true,
+    "emitDeclarationOnly": true,
+    "skipLibCheck": true,
+    "allowSyntheticDefaultImports": true
+  }
+}

package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@podium/typescript-config",
+  "version": "1.0.0",
+  "description": "Shared typescript config for Podium modules",
+  "type": "module",
+  "files": [
+    "module.json",
+    "test.json"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://[email protected]/podium-lib/typescript-config.git"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "bugs": {
+    "url": "https://github.com/podium-lib/typescript-config/issues"
+  },
+  "homepage": "https://github.com/podium-lib/typescript-config#readme",
+  "scripts": {
+    "clean": "rimraf node_modules"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "MIT",
+  "peerDependencies": {
+    "typescript": ">= 5"
+  },
+  "devDependencies": {
+    "prettier": "3.3.3",
+    "rimraf": "6.0.1",
+    "semantic-release": "24.0.0"
+  }
+}

prettier.config.js

@@ -0,0 +1,13 @@
+export default {
+    singleQuote: true,
+    trailingComma: 'all',
+    tabWidth: 4,
+    overrides: [
+        {
+            files: ['*.json', '*.yml'],
+            options: {
+                tabWidth: 2,
+            },
+        },
+    ],
+};

release.config.js

@@ -0,0 +1,22 @@
+export default {
+    plugins: [
+        '@semantic-release/commit-analyzer',
+        '@semantic-release/release-notes-generator',
+        '@semantic-release/changelog',
+        [
+            '@semantic-release/npm',
+            {
+                tarballDir: 'release',
+            },
+        ],
+        [
+            '@semantic-release/github',
+            {
+                assets: 'release/*.tgz',
+            },
+        ],
+        '@semantic-release/git',
+    ],
+    preset: 'angular',
+    branches: [{ name: 'main' }, { name: 'next', prerelease: true }],
+};