🏗️ Transform project into a monorepo (#1235)

* 🏗️ Define monorepo architecture * 🚚 Extract `gitmojis` as an isolated package * 🚚 Extract `website` as an isolated package * 🚚 Clean-up root package.json * ➕ Install `turbo` * 🔧 Setup turborepo * 👷 Use `turbo` in `ci` workflow * 👷 Update `npm-publish` workflow with `turbo` * ♻️ Migrate yarn from `classic` to `berry` * 📝 Update contributing guide * 🎨 Update readme * 📝 Add readme file for `gitmojis` package * 🚚 Move `public` folder to `website` package
carloscuesta · Dec 22, 2022 · 1ccef5a · 1ccef5a · vercel · Dec 22, 2022
1 parent 8d467e9
commit 1ccef5a
Show file tree

Hide file tree

Showing 133 changed files with 10,446 additions and 6,556 deletions.
diff --git a/.flowconfig b/.flowconfig
@@ -10,6 +10,6 @@
 [lints]
 
 [options]
-module.name_mapper='src\/\(.*\)$' -> '<PROJECT_ROOT>/src/\1'
+module.name_mapper='src\/\(.*\)$' -> '<PROJECT_ROOT>/packages/website/src/\1'
 exact_by_default=true
-react.runtime=automatic
+react.runtime=automatic
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1 @@
+/.yarn/releases/** binary
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -19,9 +19,9 @@ If you would like to add a new emoji to gitmoji, fill the provided `ISSUE_TEMPLA
 
 ## How to add a gitmoji
 
-1. Open the **gitmojis.json** file located at `src/data/gitmojis.json`.
+1. Open the **gitmojis.json** file located at `packages/gitmojis/src/gitmojis.json`.
 2. Add your emoji using the following code inside of the `gitmojis array []`:
-3. Add a new color to [the emojiColorsMap.js](https://github.com/carloscuesta/gitmoji/blob/master/src/components/GitmojiList/emojiColorsMap.js) file. Matching the name you added at the JSON file.
+3. Add a new color to [the emojiColorsMap.js](https://github.com/carloscuesta/gitmoji/blob/master/packages/website/src/components/GitmojiList/emojiColorsMap.js) file. Matching the name you added at the JSON file.
 4. Save the file and create a pull request.
 
 ```json
@@ -37,9 +37,9 @@ If you would like to add a new emoji to gitmoji, fill the provided `ISSUE_TEMPLA
 
 If you want to find the hexadecimal entity of icon, search for it in this site: <a>http://graphemica.com/</a>
 
-Every suggestion will be reviewed carefully, ⚠️ take into account that not every suggestion will be accepted! 
+Every suggestion will be reviewed carefully, ⚠️ take into account that not every suggestion will be accepted!
 
-## How to start gitmoji
+## How to start the website
 
 If you want to make changes to the site, follow the next steps:
 
@@ -50,7 +50,7 @@ $ git clone https://github.com/carloscuesta/gitmoji.git
 $ cd gitmoji
 ```
 
-2. Install the dependencies and start the development task.
+2. Install the dependencies and start the development server.
 
 ```bash
 $ yarn install && yarn run dev

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -10,19 +10,21 @@ jobs:
     strategy:
       matrix:
         node-version: [16.x]
+    env:
+      TURBO_TOKEN: ${{ secrets.TURBO_TOKEN }}
+      TURBO_TEAM: ${{ secrets.TURBO_TEAM }}
     steps:
     - uses: actions/checkout@v3
     - name: Install Node.js ${{ matrix.node-version }}
       uses: actions/setup-node@v3
       with:
+        cache: 'yarn'
         node-version: ${{ matrix.node-version }}
     - name: Install dependencies 📦
-      run: yarn
+      run: yarn install --immutable
     - name: Lint 🎨
-      run: yarn run lint
+      run: yarn turbo lint
     - name: Flow types 🏷
-      run: yarn run flow
+      run: yarn turbo flow
     - name: Tests ✅
-      run: yarn run test
-    - name: Gitmojis validation 😜
-      run: yarn run validate:gitmojis
+      run: yarn turbo test
diff --git a/.github/workflows/npm-publish.yml b/.github/workflows/npm-publish.yml
@@ -10,15 +10,16 @@ jobs:
     - uses: actions/checkout@v3
     - uses: actions/setup-node@v3
       with:
+        cache: 'yarn'
         node-version: '16'
     - name: Install dependencies 📦
-      run: yarn
+      run: yarn install --immutable
     - name: Publish package to NPM 🚀
       env:
         NPM_TOKEN: ${{ secrets.NPM_AUTOMATION_TOKEN }}
       run: |
         npm config set '//registry.npmjs.org/:_authToken' "${NPM_TOKEN}"
-        npm publish
+        yarn turbo publishPackage
     - name: Publish GitHub Release 📝
       uses: softprops/action-gh-release@v1
       with:

diff --git a/.gitignore b/.gitignore
@@ -5,12 +5,24 @@ node_modules/
 .next
 out/
 coverage/
-public/robots.txt
-public/sitemap.xml
 .eslintcache
+*.log
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
 
 # next-pwa
 public/workbox-*.js
+public/workbox-*.js
+public/sw.js
 public/sw.js
 public/*.map
-*.log
+
+# next-sitemap
+public/robots.txt
+public/sitemap.xml
+public/sitemap.xml
diff --git a/.husky/pre-push b/.husky/pre-push
@@ -1,4 +1,4 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
 
-yarn run flow && yarn run test
+yarn turbo flow && yarn turbo test
diff --git a/.lintstagedrc.json b/.lintstagedrc.json
@@ -0,0 +1,4 @@
+{
+  "*.json": ["prettier --write *.json"],
+  "*.md": ["prettier --write *.md"]
+}
diff --git a/.yarn/releases/yarn-3.3.1.cjs b/.yarn/releases/yarn-3.3.1.cjs
diff --git a/.yarnrc.yml b/.yarnrc.yml
@@ -0,0 +1,2 @@
+yarnPath: .yarn/releases/yarn-3.3.1.cjs
+nodeLinker: node-modules
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -17,23 +17,23 @@ diverse, inclusive, and healthy community.
 Examples of behavior that contributes to a positive environment for our
 community include:
 
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
   and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the
+- Focusing on what is best not just for us as individuals, but for the
   overall community
 
 Examples of unacceptable behavior include:
 
-* The use of sexualized language or imagery, and sexual attention or
+- The use of sexualized language or imagery, and sexual attention or
   advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
   address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
+- Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
 ## Enforcement Responsibilities
@@ -106,7 +106,7 @@ Violating these terms may lead to a permanent ban.
 ### 4. Permanent Ban
 
 **Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior,  harassment of an
+standards, including sustained inappropriate behavior, harassment of an
 individual, or aggression toward or disparagement of classes of individuals.
 
 **Consequence**: A permanent ban from any sort of public interaction within

diff --git a/README.md b/README.md
@@ -52,7 +52,10 @@ Are you using Gitmoji on your project? Set the Gitmoji badge on top of your read
 
 ```html
 <a href="https://gitmoji.dev">
-  <img src="https://img.shields.io/badge/gitmoji-%20😜%20😍-FFDD67.svg?style=flat-square" alt="Gitmoji">
+  <img
+    src="https://img.shields.io/badge/gitmoji-%20😜%20😍-FFDD67.svg?style=flat-square"
+    alt="Gitmoji"
+  />
 </a>
 ```
 

diff --git a/package.json b/package.json
@@ -1,180 +1,24 @@
 {
-  "name": "gitmojis",
-  "version": "3.13.0",
+  "name": "gitmoji",
+  "private": true,
   "engines": {
     "node": "16"
   },
-  "description": "An emoji guide for your commit messages.",
-  "private": false,
-  "main": "src/data/gitmojis.json",
-  "files": [
-    "src/data/gitmojis.json"
+  "workspaces": [
+    "packages/*"
   ],
   "scripts": {
-    "build": "next build",
-    "dev": "next dev",
-    "flow": "flow",
-    "lint": "eslint src && prettier --check src/**/*.{js,json,css}",
-    "postbuild": "next-sitemap",
-    "start": "next start",
-    "test": "jest --coverage",
-    "validate:gitmojis": "jsonlint ./src/data/gitmojis.json -V ./src/data/schema.json",
-    "prepublishOnly": "npm run validate:gitmojis",
-    "prepare": "husky install"
+    "prepare": "husky install",
+    "dev": "yarn turbo dev"
   },
   "devDependencies": {
-    "@babel/core": "^7.19.6",
-    "@babel/eslint-parser": "^7.19.1",
-    "@babel/preset-flow": "^7.0.0",
-    "@babel/preset-react": "^7.18.6",
-    "clipboard": "^2.0.4",
-    "eslint": "^8.26.0",
-    "eslint-config-next": "^13.0.0",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-import-resolver-alias": "^1.1.2",
-    "eslint-plugin-flowtype": "^8.0.3",
-    "eslint-plugin-jest": "^27.1.3",
-    "eslint-plugin-react": "^7.31.10",
-    "flow-bin": "^0.196.0",
-    "focus-trap-react": "^10.0.0",
     "husky": "^8.0.0",
-    "identity-obj-proxy": "^3.0.0",
-    "jest": "^29.0.1",
-    "jest-environment-jsdom": "^29.0.1",
-    "jest-fetch-mock": "^3.0.3",
-    "jsonlint": "^1.6.3",
     "lint-staged": "^13.0.0",
-    "next": "^13.0.0",
-    "next-pwa": "^5.4.4",
-    "next-sitemap": "^2.1.5",
-    "next-themes": "^0.2.0",
     "prettier": "2.8.1",
-    "prop-types": "^15.8.1",
-    "react": "^18.2.0",
-    "react-dom": "^18.2.0",
-    "react-test-renderer": "^18.2.0"
-  },
-  "author": {
-    "name": "carloscuesta",
-    "email": "[email protected]",
-    "url": "https://carloscuesta.me"
-  },
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/carloscuesta/gitmoji/issues"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/carloscuesta/gitmoji.git"
-  },
-  "homepage": "https://gitmoji.dev",
-  "keywords": [
-    "gitmoji",
-    "emoji",
-    "carloscuesta",
-    "commit"
-  ],
-  "prettier": {
-    "semi": false,
-    "singleQuote": true,
-    "arrowParens": "always"
-  },
-  "lint-staged": {
-    "*.{js,jsx}": [
-      "eslint --cache --fix",
-      "prettier --write src/**/*.{js,json,css}",
-      "git add"
-    ]
-  },
-  "jest": {
-    "collectCoverageFrom": [
-      "src/**/*.{js,jsx}"
-    ],
-    "testMatch": [
-      "**/*.(spec).(js)"
-    ],
-    "moduleNameMapper": {
-      "^.+\\.css$": "identity-obj-proxy",
-      "src/(.*)$": "<rootDir>/src/$1"
-    },
-    "testEnvironment": "jsdom"
+    "turbo": "^1.6.3"
   },
   "volta": {
     "node": "16.15.0"
   },
-  "eslintConfig": {
-    "parser": "@babel/eslint-parser",
-    "env": {
-      "jest": true,
-      "browser": true,
-      "es2021": true
-    },
-    "extends": [
-      "eslint:recommended",
-      "plugin:flowtype/recommended",
-      "plugin:react/recommended",
-      "prettier",
-      "plugin:@next/next/recommended"
-    ],
-    "parserOptions": {
-      "ecmaFeatures": {
-        "jsx": true
-      },
-      "ecmaVersion": 12,
-      "sourceType": "module",
-      "requireConfigFile": false,
-      "babelOptions": {
-        "presets": [
-          "next/babel",
-          "@babel/preset-react",
-          "@babel/preset-flow"
-        ]
-      }
-    },
-    "plugins": [
-      "react",
-      "flowtype"
-    ],
-    "rules": {
-      "flowtype/require-valid-file-annotation": [
-        2,
-        "always",
-        {
-          "annotationStyle": "line"
-        }
-      ],
-      "react/react-in-jsx-scope": "off",
-      "@next/next/no-img-element": "off",
-      "react/no-unknown-property": ["error", { "ignore": ["jsx", "global"] }]
-    },
-    "overrides": [
-      {
-        "files": [
-          "*.spec.js",
-          "stubs.js",
-          "**/__mocks__/*.js"
-        ],
-        "rules": {
-          "flowtype/require-valid-file-annotation": 0
-        }
-      }
-    ],
-    "settings": {
-      "react": {
-        "version": "detect",
-        "flowVersion": "detect"
-      },
-      "import/resolver": {
-        "alias": {
-          "map": [
-            [
-              "src",
-              "./src"
-            ]
-          ]
-        }
-      }
-    }
-  },
-  "dependencies": {}
+  "packageManager": "[email protected]"
 }
diff --git a/packages/gitmojis/.lintstagedrc.json b/packages/gitmojis/.lintstagedrc.json
@@ -0,0 +1,3 @@
+{
+  "./src/*.json": ["prettier --write ./src/*.json"]
+}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		yarnPath: .yarn/releases/yarn-3.3.1.cjs
		nodeLinker: node-modules