Skip to content

Commit

Permalink
chore: use release-it (#31)
Browse files Browse the repository at this point in the history
  • Loading branch information
cuebit authored Mar 6, 2024
1 parent 0697a24 commit 9f6d6f0
Show file tree
Hide file tree
Showing 8 changed files with 2,398 additions and 1,118 deletions.
20 changes: 20 additions & 0 deletions .release-it.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
module.exports = {
git: {
commitMessage: 'release: v${version}',
tagName: 'v${version}'
},
github: {
release: true,
releaseName: 'v${version}',
releaseNotes(context) {
return context.changelog.split('\n').slice(1).join('\n').trim()
}
},
plugins: {
'@release-it/conventional-changelog': {
preset: 'angular',
infile: 'CHANGELOG.md',
ignoreRecommendedBump: true
}
}
}
2 changes: 1 addition & 1 deletion LICENSE.md → LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2023 Global Brain Corporation
Copyright (c) 2023-PRESENT Global Brain Corporation

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
16 changes: 6 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,17 @@ This package provides the Global Brain eslint preset as an extensible shared con
pnpm add -D eslint @globalbrain/eslint-config
```

### Configure `.eslintrc.json`
### Configuration

#### `.eslintrc`

```json5
{
"extends": "@globalbrain",

"rules": {
// overrides
}
"extends": "@globalbrain"
}
```

### Configure `package.json`
#### `package.json`

```json5
{
Expand All @@ -33,8 +31,6 @@ pnpm add -D eslint @globalbrain/eslint-config
}
```

> `--ignore-path` is not required as it is configured extensively by [ignorePattern](https://github.com/antfu/eslint-config/blob/main/packages/basic/index.js#L16).
## License

This package is open-sourced software licensed under the [MIT license](LICENSE.md).
This package is open-sourced software licensed under the [MIT license](./LICENSE).
21 changes: 9 additions & 12 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,25 +21,22 @@
"index.js"
],
"scripts": {
"lint": "eslint . --fix",
"release": "tsx scripts/release.ts"
"lint": "eslint --fix .",
"release": "release-it"
},
"peerDependencies": {
"eslint": ">=7.4.0"
"eslint": "^8.0.0"
},
"dependencies": {
"@antfu/eslint-config": "0.41.0"
},
"devDependencies": {
"@types/prompts": "^2.4.9",
"@types/semver": "^7.5.6",
"conventional-changelog-cli": "~2.2.2",
"@release-it/conventional-changelog": "^8.0.1",
"eslint": "^8.56.0",
"execa": "^8.0.1",
"picocolors": "^1.0.0",
"prompts": "^2.4.2",
"semver": "^7.6.0",
"tsx": "^4.7.0",
"typescript": "^5.3.3"
"release-it": "^17.1.1"
},
"publishConfig": {
"access": "public",
"registry": "https://registry.npmjs.org"
}
}
Loading

0 comments on commit 9f6d6f0

Please sign in to comment.