refactor: rename plugins folder

Renames the `plugins` folder to `packages`: - Adapted `create` and `preapre-deploymet` scripts. - Adaped workspace configuration for npm, eslint and vitest.
SRGSSR · May 6, 2024 · 559a493 · 559a493
1 parent 1877dfa
commit 559a493
Show file tree

Hide file tree

Showing 23 changed files with 54 additions and 54 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -9,7 +9,7 @@
   "overrides": [
     {
       "files": [
-        "plugins/**/test/**"
+        "packages/**/test/**"
       ],
       "plugins": [
         "vitest"

diff --git a/docs/README.md b/docs/README.md
@@ -52,24 +52,24 @@ After running the command, you will be prompted to enter the type and name of yo
 element directory will be generated in the monorepo with the following structure:
 
 ```
-/plugins/your-element-name
+/packages/<your-element-name>
 |-- src
-|   |-- lang                      # Folder containing localization files (only if selected)
-|   `-- your-element-name.js      # Main JavaScript file for the element
+|   |-- lang                        # Folder containing localization files (only if selected)
+|   `-- <your-element-name>.js      # Main JavaScript file for the element
 |-- test
-|   `-- your-element-name.test.js # A default vitest test for your element
-|-- .babelrc                      # Babel configuration specific to this element
-|-- index.html                    # Demo page to showcase the element
-|-- package.json                  # NPM package file, you might need to install additional dependencies
-|-- README.md                     # Documentation file for the element
-|-- vite.config.lib.js            # Vite configuration for building the element as a library
-`-- vite.config.js                # Vite configuration for building the element demo page
+|   `-- <your-element-name>.test.js # A default vitest test for your element
+|-- .babelrc                        # Babel configuration specific to this element
+|-- index.html                      # Demo page to showcase the element
+|-- package.json                    # NPM package file, you might need to install additional dependencies
+|-- README.md                       # Documentation file for the element
+|-- vite.config.lib.js              # Vite configuration for building the element as a library
+`-- vite.config.js                  # Vite configuration for building the element demo page
 ```
 
 After the structure is generated, navigate into the element's directory:
 
 ```bash
-cd plugins/your-element-name
+cd packages/your-element-name
 ```
 
 The README.md file included in your element's directory provides detailed instructions on building

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -9,12 +9,12 @@
     "url": "git+https://github.com/SRGSSR/pillarbox-web-suite.git"
   },
   "workspaces": [
-    "plugins/*",
+    "packages/*",
     "themes/*"
   ],
   "scripts": {
     "create": "plop --plopfile scripts/create.js",
-    "eslint": "eslint {plugins/**/{src,test}/**/*.{js,jsx},scripts/*.{js,jsx}}",
+    "eslint": "eslint {packages/**/{src,test}/**/*.{js,jsx},scripts/*.{js,jsx}}",
     "outdated": "npm outdated",
     "prepare": "husky",
     "stylelint": "stylelint **/*.{css,scss} --allow-empty-input",

diff --git a/plugins/skip-button/.babelrc → packages/skip-button/.babelrc b/plugins/skip-button/.babelrc → packages/skip-button/.babelrc
diff --git a/plugins/skip-button/README.md → packages/skip-button/README.md b/plugins/skip-button/README.md → packages/skip-button/README.md
diff --git a/plugins/skip-button/index.html → packages/skip-button/index.html b/plugins/skip-button/index.html → packages/skip-button/index.html
diff --git a/plugins/skip-button/package.json → packages/skip-button/package.json b/plugins/skip-button/package.json → packages/skip-button/package.json
diff --git a/plugins/skip-button/scss/skip-button.scss → packages/skip-button/scss/skip-button.scss b/plugins/skip-button/scss/skip-button.scss → packages/skip-button/scss/skip-button.scss
diff --git a/plugins/skip-button/src/lang/de.json → packages/skip-button/src/lang/de.json b/plugins/skip-button/src/lang/de.json → packages/skip-button/src/lang/de.json
diff --git a/plugins/skip-button/src/lang/en.json → packages/skip-button/src/lang/en.json b/plugins/skip-button/src/lang/en.json → packages/skip-button/src/lang/en.json
diff --git a/plugins/skip-button/src/lang/fr.json → packages/skip-button/src/lang/fr.json b/plugins/skip-button/src/lang/fr.json → packages/skip-button/src/lang/fr.json
diff --git a/plugins/skip-button/src/lang/index.js → packages/skip-button/src/lang/index.js b/plugins/skip-button/src/lang/index.js → packages/skip-button/src/lang/index.js
diff --git a/plugins/skip-button/src/lang/it.json → packages/skip-button/src/lang/it.json b/plugins/skip-button/src/lang/it.json → packages/skip-button/src/lang/it.json
diff --git a/plugins/skip-button/src/lang/rm.json → packages/skip-button/src/lang/rm.json b/plugins/skip-button/src/lang/rm.json → packages/skip-button/src/lang/rm.json
diff --git a/plugins/skip-button/src/skip-button.js → packages/skip-button/src/skip-button.js b/plugins/skip-button/src/skip-button.js → packages/skip-button/src/skip-button.js
diff --git a/plugins/skip-button/test/skip-button.spec.js → ...ages/skip-button/test/skip-button.spec.js b/plugins/skip-button/test/skip-button.spec.js → ...ages/skip-button/test/skip-button.spec.js
diff --git a/plugins/skip-button/vite.config.js → packages/skip-button/vite.config.js b/plugins/skip-button/vite.config.js → packages/skip-button/vite.config.js
diff --git a/plugins/skip-button/vite.config.lib.js → packages/skip-button/vite.config.lib.js b/plugins/skip-button/vite.config.lib.js → packages/skip-button/vite.config.lib.js
diff --git a/scripts/create.js b/scripts/create.js
@@ -32,7 +32,7 @@ export default function(plop) {
     actions: data => [
       {
         type: 'addMany',
-        destination: '../plugins/{{kebabCase name}}',
+        destination: '../packages/{{kebabCase name}}',
         base: './template',
         templateFiles: './template/**',
         globOptions: {

diff --git a/scripts/prepare-deployment.js b/scripts/prepare-deployment.js
@@ -1,7 +1,7 @@
 import fs from 'fs';
 import path from 'path';
 
-const packagesDir = path.join(process.cwd(), 'plugins');
+const packagesDir = path.join(process.cwd(), 'packages');
 const deploymentDir = path.join(process.cwd(), 'dist');
 
 // Ensure the deployment directory exists
@@ -10,7 +10,7 @@ if (!fs.existsSync(deploymentDir)) {
 }
 
 // Read all package directories
-const plugins = fs.readdirSync(packagesDir);
+const packages = fs.readdirSync(packagesDir);
 const indexContent = `
 <!DOCTYPE html>
 <html>
@@ -24,17 +24,17 @@ const indexContent = `
     </style>
 </head>
 <body>
-    <h1>Available Plugins</h1>
+    <h1>Available Packages</h1>
     <ul>
-    ${plugins.map(plugin => {
-        const distDir = path.join(packagesDir, plugin, 'dist');
-        const targetDir = path.join(deploymentDir, plugin);
+    ${packages.map(packageName => {
+        const distDir = path.join(packagesDir, packageName, 'dist');
+        const targetDir = path.join(deploymentDir, packageName);
 
         // Copy if the dist directory exists
         if (fs.existsSync(distDir)) {
           fs.cpSync(distDir, targetDir, { recursive: true });
 
-          return `<li><a href="${plugin}/index.html">${plugin}</a></li>`;
+          return `<li><a href="${packageName}/index.html">${packageName}</a></li>`;
         }
     })}
     </ul>

diff --git a/vitest.config.js b/vitest.config.js
@@ -6,7 +6,7 @@ export default defineConfig({
       reporter: ['text', 'json-summary', 'json'],
       reportOnFailure: true,
       clean: true,
-      include: ['plugins/**/src/**']
+      include: ['packages/**/src/**']
     }
   }
 });
diff --git a/vitest.workspace.js b/vitest.workspace.js
@@ -1,5 +1,5 @@
 import { defineWorkspace } from 'vitest/config';
 
 export default defineWorkspace([
-  'plugins/*',
+  'packages/*',
 ]);