@binden/semantic-release-config 1.0.0

package/.releaserc.json

@@ -0,0 +1,63 @@
+{
+  "branches": "main",
+  "preset": "conventionalcommits",
+  "presetConfig": {
+    "types": [
+      { "type": "feat", "section": "Features" },
+      { "type": "fix", "section": "Bug Fixes" },
+      { "type": "perf", "section": "Performance Improvements" },
+      { "type": "revert", "section": "Reverts" },
+      { "type": "build", "section": "Build System" },
+      { "type": "initial", "section": "Initial" },
+      { "type": "dependencies", "section": "Dependencies" },
+      { "type": "peerDependencies", "section": "Peer dependencies" },
+      {
+        "type": "devDependencies",
+        "section": "Dev dependencies",
+        "hidden": true
+      },
+      { "type": "metadata", "section": "Metadata", "hidden": true },
+      { "type": "docs", "section": "Documentation", "hidden": true },
+      { "type": "style", "section": "Styles", "hidden": true },
+      {
+        "type": "chore",
+        "section": "Miscellaneous Chores",
+        "hidden": true
+      },
+      {
+        "type": "refactor",
+        "section": "Code Refactoring",
+        "hidden": true
+      },
+      { "type": "test", "section": "Tests", "hidden": true },
+      {
+        "type": "ci",
+        "section": "Continuous Integration",
+        "hidden": true
+      }
+    ]
+  },
+  "plugins": [
+    [
+      "@semantic-release/commit-analyzer",
+      {
+        "releaseRules": [
+          { "breaking": true, "release": "major" },
+          { "type": "feat", "release": "minor" },
+          { "type": "fix", "release": "patch" },
+          { "type": "perf", "release": "patch" },
+          { "type": "revert", "release": "patch" },
+          { "type": "build", "release": "patch" },
+          { "type": "initial", "release": "minor" },
+          { "type": "dependencies", "release": "patch" },
+          { "type": "peerDependencies", "release": "patch" }
+        ]
+      }
+    ],
+    "@semantic-release/release-notes-generator",
+    ["@semantic-release/changelog", { "changelogTitle": "# Changelog" }],
+    "@semantic-release/npm",
+    "@semantic-release/github",
+    "@semantic-release/git"
+  ]
+}

package/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+
+## 1.0.0 (2022-07-21)
+
+### Features
+
+- add `semantic-release` config ([b4579ab](https://github.com/binden-js/semantic-release-config/commit/b4579abff322d191cd4e6d1054dac1bb3f284bd0))
+
+### Performance Improvements
+
+- add `TypeScript` declarations ([900fa24](https://github.com/binden-js/semantic-release-config/commit/900fa247b5142bd28ef3e5ce55ec638976c49634))

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 binden-js
+
+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,31 @@
+# semantic-release-config ![CI Status](https://github.com/binden-js/semantic-release-config/workflows/CI/badge.svg) [![version](https://img.shields.io/github/package-json/v/binden-js/semantic-release-config?style=plastic)](https://github.com/binden-js/semantic-release-config) [![Known Vulnerabilities](https://snyk.io/test/github/binden-js/semantic-release-config/badge.svg)](https://snyk.io/test/github/binden-js/semantic-release-config) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release) [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org) ![GitHub top language](https://img.shields.io/github/languages/top/binden-js/semantic-release-config) ![Node.js version](https://img.shields.io/node/v/@binden/semantic-release-config) ![npm downloads](https://img.shields.io/npm/dt/@binden/semantic-release-config) ![License](https://img.shields.io/github/license/binden-js/semantic-release-config)
+
+Shareable semantic-release config.
+
+- based on [conventionalcommits](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-conventionalcommits)
+
+- updates `CHANGELOG.md`
+
+- adds GitHub tags and releases with release notes
+
+- publishes new versions to [npm](https://www.npmjs.com/)
+
+## Installation
+
+```sh
+npm i --save-dev @binden/semantic-release-config
+```
+
+## Usage
+
+- Add the `extends` property (in the `.releaserc.json` file)
+
+```json
+{ "extends": "@binden/semantic-release-config", "branches": ["v1", "main"] }
+```
+
+- Run `semantic-release`
+
+```sh
+npx semantic-release
+```

package/index.d.ts

@@ -0,0 +1,65 @@
+declare const _default: {
+  branches: "main";
+  preset: "conventionalcommits";
+  presetConfig: {
+    types: [
+      { type: "feat"; section: "Features" },
+      { type: "fix"; section: "Bug Fixes" },
+      { type: "perf"; section: "Performance Improvements" },
+      { type: "revert"; section: "Reverts" },
+      { type: "build"; section: "Build System" },
+      { type: "initial"; section: "Initial" },
+      { type: "dependencies"; section: "Dependencies" },
+      { type: "peerDependencies"; section: "Peer dependencies" },
+      {
+        type: "devDependencies";
+        section: "Dev dependencies";
+        hidden: true;
+      },
+      { type: "metadata"; section: "Metadata"; hidden: true },
+      { type: "docs"; section: "Documentation"; hidden: true },
+      { type: "style"; section: "Styles"; hidden: true },
+      {
+        type: "chore";
+        section: "Miscellaneous Chores";
+        hidden: true;
+      },
+      {
+        type: "refactor";
+        section: "Code Refactoring";
+        hidden: true;
+      },
+      { type: "test"; section: "Tests"; hidden: true },
+      {
+        type: "ci";
+        section: "Continuous Integration";
+        hidden: true;
+      }
+    ];
+  };
+  plugins: [
+    [
+      "@semantic-release/commit-analyzer",
+      {
+        releaseRules: [
+          { breaking: true; release: "major" },
+          { type: "feat"; release: "minor" },
+          { type: "fix"; release: "patch" },
+          { type: "perf"; release: "patch" },
+          { type: "revert"; release: "patch" },
+          { type: "build"; release: "patch" },
+          { type: "initial"; release: "minor" },
+          { type: "dependencies"; release: "patch" },
+          { type: "peerDependencies"; release: "patch" }
+        ];
+      }
+    ],
+    "@semantic-release/release-notes-generator",
+    ["@semantic-release/changelog", { changelogTitle: "# Changelog" }],
+    "@semantic-release/npm",
+    "@semantic-release/github",
+    "@semantic-release/git"
+  ];
+};
+
+export = _default;

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@binden/semantic-release-config",
+  "version": "1.0.0",
+  "description": "Shareable semantic-release config (based on Conventional Commits)",
+  "main": ".releaserc.json",
+  "type": "commonjs",
+  "types": "index.d.ts",
+  "engines": {
+    "node": ">=18.6.0",
+    "npm": ">=8.13.2"
+  },
+  "scripts": {
+    "commitlint": "commitlint --verbose --from=$( git rev-list --max-parents=0 $( git rev-parse --abbrev-ref HEAD ) )",
+    "install:clean": "rm -fr node_modules && rm -f package-lock.json && npm install",
+    "prepare": "husky install",
+    "prettier": "prettier -c .",
+    "prettier:write": "npm run prettier -- --write"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/binden-js/semantic-release-config.git"
+  },
+  "keywords": [
+    "semantic-release",
+    "semantic-release-config",
+    "binden"
+  ],
+  "author": "Sergey Bakulin <sergey.bakulin.github@gmail.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/binden-js/semantic-release-config/issues"
+  },
+  "homepage": "https://github.com/binden-js/semantic-release-config#readme",
+  "peerDependencies": {
+    "@semantic-release/changelog": "^6.0.1",
+    "@semantic-release/git": "^10.0.1",
+    "semantic-release": "^19.0.3"
+  },
+  "devDependencies": {
+    "@commitlint/config-conventional": "^17.0.3",
+    "commitlint": "^17.0.3",
+    "husky": "^8.0.1",
+    "lint-staged": "^13.0.3",
+    "prettier": "^2.7.1"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "funding": {
+    "type": "Coinbase Commerce",
+    "url": "https://commerce.coinbase.com/checkout/eddfb0f7-20e7-4e0d-8e04-232bbdf0b397"
+  }
+}