🦄 feature: Add the base standards, repository set up and cli for comm…

…iting locally (#1)

.editorconfig

@@ -0,0 +1,10 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+[*.{js,json,yml}]
+charset = utf-8
+indent_style = space
+indent_size = 2

.gitattributes

@@ -0,0 +1,4 @@
+/.yarn/**            linguist-vendored
+/.yarn/releases/*    binary
+/.yarn/plugins/**/*  binary
+/.pnp.*              binary linguist-generated

.gitignore

@@ -0,0 +1,134 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+# IDE
+.vscode
+.idea

.prettierignore

@@ -0,0 +1,8 @@
+dist/
+node_modules/
+build/
+*.md
+*.mdx
+.yarn
+.turbo
+.vscode

.prettierrc.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "https://json.schemastore.org/prettierrc",
+  "printWidth": 80,
+  "tabWidth": 2,
+  "useTabs": false,
+  "semi": false,
+  "singleQuote": true,
+  "experimentalTernaries": true,
+  "singleAttributePerLine": true,
+  "jsxSingleQuote": true,
+  "bracketSameLine": false,
+  "bracketSpacing": true,
+  "quoteProps": "as-needed",
+  "trailingComma": "es5",
+  "arrowParens": "always"
+}

.yarnrc.yml

@@ -0,0 +1,18 @@
+nodeLinker: node-modules
+
+supportedArchitectures:
+  cpu:
+    - current
+    - x64
+    - arm
+    - ia32
+  libc:
+    - glibc
+    - musl
+  os:
+    - current
+    - darwin
+    - linux
+    - win32
+
+yarnPath: .yarn/releases/yarn-4.1.0.cjs

README.md

@@ -1,11 +1,11 @@
 <div>
     <p align="center">
-        <img src="/.github/assets/unicorn.png" align="center" width="240" />
+        <img src="/.github/assets/unicorn.png" align="center" width="360" />
     </p>
     <hr>
 </div>
 
-> 🦄 Magical commits to add some zest to your life as a developer, by using emojis to signal commit & pull-request intent.
+> 🦄 Magical commits to add some zest to your life, by using emojis to signal commit & pull-request intent.
 
 ## ✅ The Standard
 

docs/standards.md

@@ -0,0 +1,25 @@
+# 🦄 Unicorn Commit & Pull Request Standards
+
+A set of standards for commit messages and pull request titles, with a magical zest.
+
+## 📋 Commit Message Standards
+
+| group | emoji | example |
+| ----- | ----- | ------- |
+| feature | 🦄 | 🦄 feature: example commit message |
+| bugfix | 🐛 | 🐛 bugfix: example commit message |
+| hotfix | 🔥 | 🔥 hotfix: example commit message |
+| dependencies | 📦 | 📦 dependencies: example commit message |
+| chore | 🧰 | 🧰 chore: example commit message |
+| docs | 📚 | 📚 docs: example commit message |
+
+## 📋 Pull Request Title Standards
+
+| group | emoji | example |
+| ----- | ----- | ------- |
+| feature | 🦄 | 🦄 feature: example pull request title |
+| bugfix | 🐛 | 🐛 bugfix: example pull request title |
+| hotfix | 🔥 | 🔥 hotfix: example pull request title |
+| dependencies | 📦 | 📦 dependencies: example pull request title |
+| chore | 🧰 | 🧰 chore: example pull request title |
+| docs | 📚 | 📚 docs: example pull request title |

package.json

@@ -0,0 +1,30 @@
+{
+  "name": "unicorn",
+  "description": "🦄 Magical commits to add some zest to your life, by using emojis to signal commit & pull-request intent.",
+  "license": "MIT",
+  "keywords": [
+    "emoji",
+    "git",
+    "commit",
+    "pull-request",
+    "gitmoji",
+    "unicorn"
+  ],
+  "packageManager": "[email protected]",
+  "scripts": {
+    "format": "prettier --write .",
+    "lint": "standard --fix .",
+    "docs": "ts-node ./scripts/generate-docs.ts"
+  },
+  "workspaces": [
+    "packages/*"
+  ],
+  "devDependencies": {
+    "@joggr/tempo": "^0.6.0",
+    "prettier": "^3.2.5",
+    "standard": "^17.1.0",
+    "ts-node": "^10.9.2",
+    "vite": "^5.1.1",
+    "vite-plugin-dts": "^3.7.2"
+  }
+}

packages/heart/README.md

@@ -0,0 +1 @@
+# standards

packages/heart/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "heart",
+  "description": "💗 The beating heart of unicorn, the commit and pull-request standards.",
+  "packageManager": "[email protected]",
+  "scripts": {
+    "build": "vite build",
+    "dev": "vite",
+    "test": "vitest"
+  },
+  "exports": {
+    ".": {
+      "import": "./dist/heart.mjs",
+      "require": "./dist/heart.umd.js"
+    }
+  },
+  "main": "./dist/heart.umd.js",
+  "module": "./dist/heart.mjs",
+  "types": "./dist/index.d.ts",
+  "dependencies": {
+    "@joggr/tempo": "^0.6.0"
+  },
+  "devDependencies": {
+    "prettier": "^3.2.5",
+    "standard": "^17.1.0",
+    "typescript": "^5.3.3",
+    "vite": "^5.1.1",
+    "vite-plugin-dts": "^3.7.2",
+    "vitest": "^1.2.2"
+  }
+}