✨ feature: created generic commit message markdown and a helper script for it

created a markdown to reference when making commits without the cz command as well as a helper script to update the emoji and types from the gitmoji repo

Author: jebarpg

repo_management_files/cz-emoji-type-extract.js

@@ -0,0 +1,43 @@
+/* eslint-disable security/detect-object-injection */
+/* eslint-disable guard-for-in */
+/* eslint-disable no-restricted-syntax */
+import { get } from 'https';
+import { writeFile } from 'fs';
+
+const url =
+  'https://raw.github.com/jebarpg/cz-gitmoji-adapter/main/lib/types.json';
+
+get(url, (res) => {
+  let body = '';
+  res.on('data', (chunk) => {
+    body += chunk;
+  });
+  res.on('end', () => {
+    try {
+      const json = JSON.parse(body);
+
+      let content = '<details>\n  <summary>Scoped</summary>\n';
+      for (const i in json) {
+        const emoji = json[i].emoji;
+        const name = json[i].name;
+        content += `${emoji} ${name}(scope):<br>\n`;
+      }
+      content += `</details>\n\n<details>\n  <summary>No Scope</summary>\n`;
+      for (const i in json) {
+        const emoji = json[i].emoji;
+        const name = json[i].name;
+        content += `${emoji} ${name}:<br>\n`;
+      }
+      content += `</details>`
+      writeFile('emojiTypesCommitMessages.txt', content, (err) => {
+        if (err) {
+          console.error(err);
+        }
+      });
+    } catch (error) {
+      console.error(error.message);
+    }
+  });
+}).on('error', (error) => {
+  console.error(error.message);
+});

repo_management_files/genericCommitMessages.md

@@ -0,0 +1,163 @@
+# Generic Commit Messages
+
+If you are making a commit without using the `cz` commit or the `bun cm` or `bun cm2` scripts then these are handy to copy and used to format your commits with. 
+
+## Examples of when you would use these
+
+* Doing a merge in Visual Studio Code and are prompted with VIM to enter a message.
+* When you need to do a manual `git commit -m ""` on the CLI.
+* When you are using the Visual Studio Code Source Control tab to make a commit using it's message text box.
+
+## Scoped example
+
+🐛 fix(scopeName): Message
+
+## No Scope example
+
+🐛 fix: fixing merge
+
+## Emojis and Type names
+
+Click the type of message you would like to use below and copy into your commit message. Remember to change teh scope to the appropriate scope of your project if you choose a scoped message.
+
+<details>
+  <summary>Scoped</summary>
+🎨 style(scope):<br>
+⚡️ perf(scope):<br>
+🔥 prune(scope):<br>
+🐛 fix(scope):<br>
+🚑 quickfix(scope):<br>
+✨ feature(scope):<br>
+📝 docs(scope):<br>
+🚀 deploy(scope):<br>
+💄 ui(scope):<br>
+🎉 init(scope):<br>
+✅ test(scope):<br>
+🔒 security(scope):<br>
+🔖 release(scope):<br>
+🚨 lint(scope):<br>
+🚧 wip(scope):<br>
+💚 fix-ci(scope):<br>
+⬇️ downgrade(scope):<br>
+⬆️ upgrade(scope):<br>
+📌 pushpin(scope):<br>
+👷 ci(scope):<br>
+📈 analytics(scope):<br>
+♻️ refactoring(scope):<br>
+➕ dep-add(scope):<br>
+➖ dep-rm(scope):<br>
+🔧 config(scope):<br>
+🌐 i18n(scope):<br>
+✏️ typo(scope):<br>
+💩 poo(scope):<br>
+⏪ revert(scope):<br>
+🔀 merge(scope):<br>
+📦 dep-up(scope):<br>
+👽 compat(scope):<br>
+🚚 mv(scope):<br>
+📄 license(scope):<br>
+💥 breaking(scope):<br>
+🍱 assets(scope):<br>
+♿️ access(scope):<br>
+💡 docs-code(scope):<br>
+🍻 beer(scope):<br>
+💬 texts(scope):<br>
+🗃️ db(scope):<br>
+🔊 log-add(scope):<br>
+🔇 log-rm(scope):<br>
+👥 contrib-add(scope):<br>
+🚸 ux(scope):<br>
+🏗️ arch(scope):<br>
+📱 iphone(scope):<br>
+🤡 clown-face(scope):<br>
+🥚 egg(scope):<br>
+🙈 see-no-evil(scope):<br>
+📸 camera-flash(scope):<br>
+⚗️ experiment(scope):<br>
+🔍 seo(scope):<br>
+🏷️ types(scope):<br>
+🌱 seed(scope):<br>
+🚩 flags(scope):<br>
+💫 animation(scope):<br>
+🗑️ wastebasket(scope):<br>
+🛂 passport-control(scope):<br>
+🩹 adhesive-bandage(scope):<br>
+🧐 monocle-face(scope):<br>
+⚰️ coffin(scope):<br>
+🧪 test-tube(scope):<br>
+👔 necktie(scope):<br>
+🩺 stethoscope(scope):<br>
+🧱 bricks(scope):<br>
+🧑‍💻 technologist(scope):<br>
+</details>
+
+<details>
+  <summary>No Scope</summary>
+🎨 style:<br>
+⚡️ perf:<br>
+🔥 prune:<br>
+🐛 fix:<br>
+🚑 quickfix:<br>
+✨ feature:<br>
+📝 docs:<br>
+🚀 deploy:<br>
+💄 ui:<br>
+🎉 init:<br>
+✅ test:<br>
+🔒 security:<br>
+🔖 release:<br>
+🚨 lint:<br>
+🚧 wip:<br>
+💚 fix-ci:<br>
+⬇️ downgrade:<br>
+⬆️ upgrade:<br>
+📌 pushpin:<br>
+👷 ci:<br>
+📈 analytics:<br>
+♻️ refactoring:<br>
+➕ dep-add:<br>
+➖ dep-rm:<br>
+🔧 config:<br>
+🌐 i18n:<br>
+✏️ typo:<br>
+💩 poo:<br>
+⏪ revert:<br>
+🔀 merge:<br>
+📦 dep-up:<br>
+👽 compat:<br>
+🚚 mv:<br>
+📄 license:<br>
+💥 breaking:<br>
+🍱 assets:<br>
+♿️ access:<br>
+💡 docs-code:<br>
+🍻 beer:<br>
+💬 texts:<br>
+🗃️ db:<br>
+🔊 log-add:<br>
+🔇 log-rm:<br>
+👥 contrib-add:<br>
+🚸 ux:<br>
+🏗️ arch:<br>
+📱 iphone:<br>
+🤡 clown-face:<br>
+🥚 egg:<br>
+🙈 see-no-evil:<br>
+📸 camera-flash:<br>
+⚗️ experiment:<br>
+🔍 seo:<br>
+🏷️ types:<br>
+🌱 seed:<br>
+🚩 flags:<br>
+💫 animation:<br>
+🗑️ wastebasket:<br>
+🛂 passport-control:<br>
+🩹 adhesive-bandage:<br>
+🧐 monocle-face:<br>
+⚰️ coffin:<br>
+🧪 test-tube:<br>
+👔 necktie:<br>
+🩺 stethoscope:<br>
+🧱 bricks:<br>
+🧑‍💻 technologist:<br>
+</details>