Skip to content

Commit

Permalink
feat: set up shareable config
Browse files Browse the repository at this point in the history
- adds .gitignore (in config dir and symlink to it)
- adds config dir for shared configuration
- creates config/eslint.config.js with placeholder info
- adds version bump script
- adds github job for publishing
  • Loading branch information
echo-bravo-yahoo committed Oct 22, 2024
1 parent 67faa79 commit c18c039
Show file tree
Hide file tree
Showing 7 changed files with 114 additions and 2 deletions.
28 changes: 28 additions & 0 deletions .github/workflows/npm-publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs

name: Publish to NPM

on:
push:
branches: [ "main", "publish-test" ]

jobs:
build:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4
- name: Use Node.js (22.x)
uses: actions/setup-node@v4
with:
node-version: 22.x
registry-url: https://registry.npmjs.org/
cache: 'npm'
- run: npm ci
- run: npm run build --if-present
- run: npm test --if-present
- run: npm run bump --if-present
- run: npm publish --access public
env:
NODE_AUTH_TOKEN: ${{secrets.npm_token}}
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
node_modules
1 change: 1 addition & 0 deletions config/.gitignore
9 changes: 9 additions & 0 deletions config/eslint.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
// eslint.config.js
module.exports = [
{
rules: {
semi: "error",
"prefer-const": "error"
}
}
];
43 changes: 43 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 9 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,12 @@
"description": "A collection of lint, format, and build configs used at Fauna for TypeScript projects.",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
"test": "echo \"Error: no test specified\" && exit 1",
"bump": "node ./scripts/version-bump.js"
},
"files": [
"config/**"
],
"repository": {
"type": "git",
"url": "git+https://github.com/fauna/typescript.git"
Expand All @@ -15,5 +19,8 @@
"bugs": {
"url": "https://github.com/fauna/typescript/issues"
},
"homepage": "https://github.com/fauna/typescript#readme"
"homepage": "https://github.com/fauna/typescript#readme",
"dependencies": {
"parse-commit-message": "^5.0.4"
}
}
23 changes: 23 additions & 0 deletions scripts/version-bump.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
#!/usr/bin/env node

const { execSync } = require('node:child_process');
const { parseHeader } = require('parse-commit-message');

const latestCommitMessage = execSync("git log -1 --pretty=%B");
const { type, scope } = parseHeader(latestCommitMessage);

let flag;
if (scope === 'patch' || ['fix', 'chore', 'docs', 'refactor', 'perf', 'test', 'build'].includes(type)) {
flag = '--patch';
} else if (scope === 'minor' || ['feat', 'feature'].includes(type)) {
flag = '--minor';
} else if (scope === 'major') {
flag = '--major';
} else {
flag = '--patch';
}

execSync(`npm version ${flag}`);
execSync("git add package.json");
execSync("git commit --amend --no-edit");
execSync("git push --force");

0 comments on commit c18c039

Please sign in to comment.