New Monorepo Architecture

.eslintignore

@@ -1,5 +1,6 @@
 node_modules
 dist
 pnpm-lock.yaml
-CHANGELOG.en-US.md
+storybook-static
+coverage
 !.*

.eslintrc.cjs

@@ -0,0 +1,30 @@
+const { defineConfig } = require('eslint-define-config');
+
+module.exports = defineConfig({
+  root: true,
+  parser: 'vue-eslint-parser',
+  parserOptions: {
+    parser: '@typescript-eslint/parser',
+    ecmaVersion: 'latest',
+    sourceType: 'module',
+    extraFileExtensions: ['.vue'],
+    project: ['./tsconfig.eslint.json']
+  },
+  env: {
+    browser: true,
+    node: true
+  },
+  extends: [
+    '@prestashopcorp/eslint-config-ts',
+    'plugin:vue/vue3-recommended'
+  ],
+  rules: {
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    '@typescript-eslint/restrict-template-expressions': 'off',
+    '@typescript-eslint/strict-boolean-expressions': 'off',
+    '@typescript-eslint/consistent-type-definitions': 'off',
+    '@typescript-eslint/consistent-type-assertions': 'off',
+    '@typescript-eslint/restrict-plus-operands': 'off',
+    'no-template-curly-in-string': 'off'
+  }
+});

.github/renovate.json5

@@ -11,9 +11,6 @@
     },
   ],
   ignoreDeps: [
-    // Latest breaks build
-    'ts-morph',
-    'type-fest',
     // MDX style is broken for 0.4.x
     '@storybook/builder-vite',
   ],

.github/workflows/cd-publish-package.yml

@@ -15,23 +15,38 @@ jobs:
       packages: write
 
     steps:
-      - name: Checkout repository
-        uses: actions/checkout@v3
-
       - name: Get tag
         id: get_tag
         run: echo ::set-output name=TAG::$(echo $GITHUB_REF | cut -d / -f 3)
 
-      - name: Get git head
-        id: get_head
-        run: echo ::set-output name=GIT_HEAD::$(echo $GITHUB_SHA)
+      - name: Checkout repository
+        uses: actions/checkout@v3
 
-      - name: Build and Publish
-        uses: ./.github/actions/build-and-publish
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v2
         with:
-          git_author_email: [email protected]
-          node_version: 18
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          npm_token: ${{ secrets.NPM_TOKEN }}
-          version: ${{ steps.get_tag.outputs.TAG }}
-          git_head: ${{ steps.get_head.outputs.GIT_HEAD }}
+          version: 8.x.x
+
+      - name: Setup node env 🏗
+        uses: actions/setup-node@v3
+        with:
+          node-version: lts/hydrogen
+          registry-url: https://registry.npmjs.org/
+          cache: "pnpm"
+
+      - name: Install dependencies 👨🏻‍💻
+        run: pnpm i --frozen-lockfile
+
+      - name: Build
+        run: pnpm build
+
+      - name: Update npm version
+        run: pnpm version $VERSION --no-git-tag-version --allow-same-version
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+          VERSION: ${{ steps.get_tag.outputs.TAG }}
+
+      - name: Publish
+        run: pnpm publish --no-git-checks --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/ci.yml

@@ -44,7 +44,4 @@ jobs:
         run: pnpm lint
 
       - name: Run tests 🧪
-        run: pnpm test
-
-      - name: Run coverage 📈
         run: pnpm coverage

.gitignore

@@ -17,4 +17,5 @@ packages/puik/version.ts
 *.local
 
 # playground test file
-playground/src/App.vue
+playground/src/App.vue
+storybook-static

.husky/pre-commit

@@ -1,5 +1,4 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
 
-pnpm exec lint-staged
-pnpm exec pretty-quick --staged
+pnpm exec lint-staged

.vscode/settings.json

@@ -29,5 +29,6 @@
   "i18n-ally.localesPaths": "packages/locale/lang",
   "i18n-ally.enabledParsers": ["ts"],
   "i18n-ally.enabledFrameworks": ["vue", "vue-sfc"],
-  "i18n-ally.keystyle": "nested"
+  "i18n-ally.keystyle": "nested",
+  "eslint.format.enable": true
 }

CONTRIBUTING.md

@@ -10,12 +10,35 @@ If you want to contribute to this project, make your PR from a feature branch to
 
 ⚠️ We use `commitlint` for conventional commit format. ([How to use](https://github.com/conventional-changelog/commitlint))
 
+You can also use [commitizen](https://github.com/commitizen/cz-cli) to create your commit with an interactive command line to respect our commit conventions
+
+```sh
+$ pnpm cz
+```
+
+## Mono repository structure
+
+This mono repository contains multiple packages under the folder `packages`
+- `components` contains all the vue components and is released under the name `@prestashopcorp/puik-components`
+- `locale` contains all the translations files for the default wording in the components, this package is bundled with the other packages when it's used and isn't released as a standalone
+- `puik` contains all the other packages and is released under the name `@prestashopcorp/puik`
+- `resolver` contains the code of the vue component resolver for [unplugin-vue-components](https://github.com/unplugin/unplugin-vue-components) and is released under the name `@prestashopcorp/puik-resolver`
+- `tailwind-preset` contains the [Tailwind Css](https://tailwindcss.com/) preset and is released under the name `@prestashopcorp/puik-tailwind-preset`
+- `theme` contains all the CSS classes used in our components and is released under the name `@prestashopcorp/puik-theme`
+- `utils` contains all the utility functions used across our packages, this package is bundled with the other packages when it's used and isn't released as a standalone
+
+The `playground` folder contains a Vue 3 to help you develop your components
+
+The `docs` folder contains the configuration and the global documentation of the [Storybook](https://storybook.js.org/)
+
+ℹ️ All the packages with the `private: true` property in the `package.json` aren't released but bundled when used
+
 ## Development
 
 ### Prerequisites
 
-- NodeJS >= 16
-- [PNPM 6 or higher](https://pnpm.io/)
+- NodeJS >= 18
+- [PNPM 8 or higher](https://pnpm.io/)
 
 ### Local development
 
@@ -35,7 +58,7 @@ $ pnpm dev
 
 ```vue
 <script setup lang="ts">
-import { PuikComponent } from '@puik/components'
+import { PuikComponent } from '@prestashopcorp/puik-components'
 </script>
 
 <template>
@@ -58,29 +81,29 @@ This command generates multiples files and injects code in these files
 
 ```
 puik/
-├── packages/
-│   ├── components/
-│   │   ├── my-component/
-│   │   │   ├── src/
-│   │   │   │   ├── my-component.ts
-│   │   │   │   └── my-component.vue
-│   │   │   ├── stories/
-│   │   │   │   └── my-component.stories.ts
-│   │   │   ├── style/
-│   │   │   │   ├── css.ts
-│   │   │   │   └── index.ts
-│   │   │   ├── test/
-│   │   │   │   └── my-component.spec.ts
-│   │   │   └── index.ts
-│   │   └── index.ts
-│   ├── puik/
-│   │   └── component.ts
-│   └── theme/
-│       └── src/
-│           ├── my-component.scss
-│           └── index.scss
-└── typings/
-    └── global.d.ts
+└── packages/
+    ├── components/
+    │   ├── my-component/
+    │   │   ├── src/
+    │   │   │   ├── my-component.ts
+    │   │   │   └── my-component.vue
+    │   │   ├── stories/
+    │   │   │   └── my-component.stories.ts
+    │   │   ├── style/
+    │   │   │   ├── css.ts
+    │   │   │   └── index.ts
+    │   │   ├── test/
+    │   │   │   └── my-component.spec.ts
+    │   │   └── index.ts
+    │   └── index.ts
+    ├── puik/
+    │   ├── component.ts
+    │   └── global.d.ts
+    └── theme/
+        └── src/
+            ├── my-component.scss
+            └── index.scss
+
 ```
 
 ### Style