🆕 feat: Added release-it and breaking changes

anjerodev · Jun 28, 2023 · 778af86 · 778af86
1 parent e234370
commit 778af86
Show file tree

Hide file tree

Showing 11 changed files with 2,900 additions and 479 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -0,0 +1,18 @@
+{
+  "env": {
+    "es2021": true,
+    "node": true
+  },
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "prettier"
+  ],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": "latest",
+    "sourceType": "module"
+  },
+  "plugins": ["@typescript-eslint"],
+  "rules": {}
+}
diff --git a/.gcomrc b/.gcomrc
@@ -7,24 +7,24 @@
     "infer_type_from_branch": true,
     "emojis": true,
     "options": [
-      {
-        "value": "refactor",
-        "label": "refactor",
-        "hint": "A general code change that does not add a feature or fix a bug.",
-        "emoji": "🔨"
-      },
       {
         "value": "feat",
         "label": "feat",
-        "hint": "Add new feature",
-        "emoji": "✨"
+        "hint": "A new feature",
+        "emoji": "🆕"
       },
       {
         "value": "fix",
         "label": "fix",
-        "hint": "Fixing a bug",
+        "hint": "A bug fix",
         "emoji": "🐛"
       },
+      {
+        "value": "refactor",
+        "label": "refactor",
+        "hint": "A code change that neither fixes a bug nor adds a feature",
+        "emoji": "♻️"
+      },
       {
         "value": "perf",
         "label": "perf",
@@ -34,32 +34,38 @@
       {
         "value": "docs",
         "label": "docs",
-        "hint": "Add or update documentation",
-        "emoji": "📚"
+        "hint": "Documentation only changes",
+        "emoji": "📝"
       },
       {
-        "value": "format",
-        "label": "format",
-        "hint": "Updating the UI and style files.",
+        "value": "style",
+        "label": "style",
+        "hint": "Changes that do not affect the meaning of the code",
         "emoji": "💅"
       },
       {
         "value": "test",
         "label": "test",
-        "hint": "Adding or updating tests",
+        "hint": "Adding missing tests or correcting existing tests",
         "emoji": "✅"
       },
       {
-        "value": "translation",
-        "label": "translation",
-        "hint": "Changes in translation files",
+        "value": "int",
+        "label": "int",
+        "hint": "Changes that affect internationalization",
         "emoji": "🌍"
       },
       {
         "value": "build",
         "label": "build",
         "hint": "Changes that affect the build system or external dependencies",
-        "emoji": "🚧"
+        "emoji": "🏗️"
+      },
+      {
+        "value": "ci",
+        "label": "ci",
+        "hint": "Changes to our CI configuration files and scripts",
+        "emoji": "🔧"
       },
       {
         "value": "clean",
@@ -156,8 +162,8 @@
   "branch_description": {
     "max_length": 70
   },
-  "confirm_push": true,
-  "push_changes": {
-    "enable": true
+  "push": {
+    "enable": true,
+    "confirm": true
   }
-}
+}
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,4 @@
 node_modules
-dist
+dist
+.env
+.env*
diff --git a/.release-it.json b/.release-it.json
@@ -0,0 +1,37 @@
+{
+  "git": {
+    "requireBranch": "main",
+    "commitMessage": "🔖 chore: release v${version}"
+  },
+  "hooks": {
+    "before:init": ["pnpm lint"],
+    "after:bump": "pnpm build",
+    "after:release": "echo Successfully released ${name} v${version} to ${repo.repository}.",
+    "after:publish": "echo Successfully publish v${version}."
+  },
+  "github": {
+    "release": true
+  },
+  "npm": {
+    "ignoreVersion": true
+  },
+  "plugins": {
+    "@release-it/conventional-changelog": {
+      "infile": "CHANGELOG.md",
+      "preset": {
+        "name": "conventionalcommits",
+        "types": [
+          {
+            "type": "✨ feat",
+            "section": "Features"
+          },
+          {
+            "type": "🐛 fix",
+            "section": "Bug Fixes"
+          },
+          {}
+        ]
+      }
+    }
+  }
+}
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "gcom",
   "private": false,
-  "version": "0.0.1",
+  "version": "1.0.0",
   "description": "A CLI to assits you in the commits creations.",
   "main": "dist/index.js",
   "publishConfig": {
@@ -13,30 +13,32 @@
   "scripts": {
     "start": "jiti ./src/bin.ts",
     "build": "tsup ./src/",
-    "commit": "jiti ./src/bin.ts"
+    "commit": "jiti ./src/bin.ts",
+    "lint": "eslint ./src",
+    "release": "dotenv release-it --"
   },
   "keywords": [],
   "author": "Jepri Creations",
   "license": "ISC",
   "dependencies": {
     "@bdsqqq/try": "2.3.1",
     "@clack/prompts": "0.6.3",
+    "dotenv-cli": "7.2.1",
     "picocolors": "1.0.0",
+    "typescript": "^5.1.5",
     "zod": "3.21.4",
     "zod-validation-error": "1.3.1"
   },
   "devDependencies": {
+    "@release-it/conventional-changelog": "5.1.1",
     "@types/node": "20.3.1",
+    "@typescript-eslint/eslint-plugin": "5.60.1",
+    "@typescript-eslint/parser": "5.60.1",
+    "eslint": "8.43.0",
     "eslint-config-prettier": "8.8.0",
     "jiti": "1.18.2",
     "prettier": "2.8.8",
-    "standard": "17.1.0",
+    "release-it": "15.11.0",
     "tsup": "7.1.0"
-  },
-  "eslintConfig": {
-    "extends": [
-      "standard",
-      "prettier"
-    ]
   }
 }