@nizza/devkit 0.1.0 → 0.1.1

package/README.md

@@ -1,3 +1,63 @@
-# Devkit
+# DevKit
 
-Necessary resources to manage and extend the nizza and perant monorepos.
+DevKit is a library designed to provide the necessary resources to manage and extend the Nizza and Perant monorepos. Featuring a reusable Vite.js codebase, it simplifies the creation of `vite.config.ts` files for every library and application within the monorepo. Additionally, it includes several NX executors to aid in performing tasks within apps and libs efficiently.
+
+## Key Features
+
+- **Simplified Vite.js Configuration:** Easily generate `vite.config.ts` files leveraging our reusable codebase.
+- **Custom NX Executors:** Automate common tasks with our specially designed executors for our monorepos.
+
+## Executors
+
+DevKit includes a variety of executors to automate and ease the handling of tasks within your project, such as:
+
+- **Environments:** Generates environment files (`environment.ts`, `environment.local.ts`, etc.) in the `src/environments` directory, utilizing the project's configuration.
+- **VTEX Link:** Links a package to a VTEX project, facilitating integration and deployment of changes.
+- **Publish:** Automates the process of publishing packages to npm, including version checks and support for dry run testing.
+- **Update Executors File:** Updates paths in the `executors.json` file to point to the correct locations after changes in the project structure.
+- **Deploy:** Deploys project assets to an AWS S3 bucket and invalidates CloudFront distribution cache.
+
+## Usage
+
+To use the executors included in DevKit, you don't need NX installed globally due to the inclusion of an `nx` script in your root `package.json`. Each executor is configured and run through the `nx.json` or via specific NX commands using `pnpm`.
+
+## Working with DevKit
+
+DevKit streamlines the development and management processes within the Nizza and Perant monorepos. Here are the key commands you can use:
+
+### Building
+
+```bash
+pnpm nx run devkit:build:dev
+pnpm nx run devkit:build:prod
+```
+
+### Linting
+
+```bash
+pnpm nx run devkit:lint
+```
+
+### Cleaning
+
+```bash
+pnpm nx run devkit:clean
+```
+
+### Versioning
+
+Manage your project versions effectively.
+
+```bash
+pnpm nx run devkit:version
+```
+
+### Environment-Specific Commands
+
+DevKit supports environment-specific commands for `dev`, `staging`, and `prod`, allowing easy management and deployment across different development stages.
+
+For example, to deploy your project in a production environment:
+
+```bash
+pnpm nx run devkit:deploy:prod
+```

package/dist/cjs/executors/deploy/schema.json

@@ -2,12 +2,12 @@
   "$schema": "http://json-schema.org/schema",
   "version": 2,
   "title": "Deploy executor",
-  "description": "",
+  "description": "Deploys project assets to an AWS S3 bucket and invalidates CloudFront distribution cache",
   "type": "object",
   "properties": {
     "s3BucketPath": {
       "type": "string",
-      "description": "S3 BUCKET ROUTE"
+      "description": "The AWS S3 bucket path where the project assets will be deployed. Format: 's3://bucket-name/path'"
     },
     "customPath": {
       "type": "string",
@@ -15,11 +15,11 @@
     },
     "cloudFrontDistributionId": {
       "type": "string",
-      "description": "Cloudfront distribution id for cache invalidation"
+      "description": "The ID of the AWS CloudFront distribution for cache invalidation, ensuring updated assets are served."
     },
     "cloudFrontInvalidationPaths": {
       "type": "array",
-      "description": "Cloudfront path list that must be invalidated in the cache",
+      "description": "List of paths to invalidate in the CloudFront cache. Specify at least one path. Example: ['/index.html']",
       "items": {
         "type": "string"
       },

package/dist/cjs/executors/environments/schema.json

@@ -1,8 +1,8 @@
 {
   "$schema": "http://json-schema.org/schema",
   "version": 2,
-  "title": "Environments executor",
-  "description": "",
+  "title": "Environments Executor",
+  "description": "Generates 'environment.ts', 'environment.local.ts', 'environment.prod.ts', and 'environment.staging.ts' files in the 'src/environments' directory if they don't exist, using the project's configuration and package name. Ensures the environments directory exists and standardizes setup for development, local, production, and staging configurations.",
   "type": "object",
   "properties": {},
   "required": []

package/dist/cjs/executors/publish/schema.json

@@ -2,16 +2,16 @@
   "$schema": "http://json-schema.org/schema",
   "version": 2,
   "title": "Publish executor",
-  "description": "",
+  "description": "Automates the process of publishing a package to npm, requiring prior npm authentication. It checks if the current version is greater than both the latest published version and the specified tag version. Supports a dry run mode for testing without actual publication.",
   "type": "object",
   "properties": {
     "tag": {
       "type": "string",
-      "description": "Tag name to publish"
+      "description": "The tag name to publish under, used for identifying release channels (e.g., 'alpha', 'beta', 'latest')."
     },
     "dryRun": {
       "type": "boolean",
-      "description": "Indicates whether a test execution should be done without really publishing",
+      "description": "Executes the publish process without actually publishing to npm, allowing for validation and testing of the process.",
       "default": false
     }
   },

package/dist/cjs/executors/shared/utils.cjs

@@ -53,10 +53,20 @@ async function runCommand(command, cwd) {
             }
         });
         devkit.logger.info(stdout);
-        devkit.logger.info(stderr);
+        if (stderr) {
+            devkit.logger.error('Error Output:');
+            devkit.logger.error(stderr);
+        }
     } catch (error) {
         devkit.logger.error(`Unexpected error running command:`);
-        devkit.logger.error(error);
+        if (error.stdout) {
+            devkit.logger.error('Standard Output:');
+            devkit.logger.error(error.stdout);
+        }
+        if (error.stderr) {
+            devkit.logger.error('Error Output:');
+            devkit.logger.error(error.stderr);
+        }
         throw error;
     }
 }

package/dist/cjs/executors/update-executors-file/schema.json

@@ -1,8 +1,8 @@
 {
   "$schema": "http://json-schema.org/schema",
   "version": 2,
-  "title": "UpdateExecutorsFile executor",
-  "description": "",
+  "title": "UpdateExecutorsFile Executor",
+  "description": "Executor for updating paths in the executors.json file, ensuring they point to the correct locations after changes in the project structure.",
   "type": "object",
   "properties": {},
   "required": []

package/dist/cjs/node_modules/.pnpm/{@vitejs_plugin-basic-ssl@1.1.0_vite@5.0.12 → @vitejs_plugin-basic-ssl@1.1.0_vite@5.2.10_@types_node@18.19.31_sass@1.75.0_}/node_modules/@vitejs/plugin-basic-ssl/dist/index.cjs

@@ -10,7 +10,7 @@ function viteBasicSslPlugin(options) {
   return {
     name: "vite:basic-ssl",
     async configResolved(config) {
-      const certificate = await getCertificate(options?.certDir ?? (config.cacheDir ?? defaultCacheDir) + "/basic-ssl", options?.name, options?.domains);
+      const certificate = await getCertificate((config.cacheDir ?? defaultCacheDir) + "/basic-ssl", options?.name, options?.domains);
       const https = () => ({ cert: certificate, key: certificate });
       if (config.server.https === void 0 || !!config.server.https) {
         config.server.https = Object.assign({}, config.server.https, https());

package/dist/cjs/vitejs/config-builder/plugins.cjs

@@ -19,7 +19,7 @@ require('crypto');
 require('fs');
 require('chalk');
 require('mri');
-var index$1 = require('../../node_modules/.pnpm/@vitejs_plugin-basic-ssl@1.1.0_vite@5.0.12/node_modules/@vitejs/plugin-basic-ssl/dist/index.cjs');
+var index$1 = require('../../node_modules/.pnpm/@vitejs_plugin-basic-ssl@1.1.0_vite@5.2.10_@types_node@18.19.31_sass@1.75.0_/node_modules/@vitejs/plugin-basic-ssl/dist/index.cjs');
 
 /**
  * Base plugins configuration for apps and libs.

package/dist/esm/executors/deploy/schema.json

@@ -2,12 +2,12 @@
   "$schema": "http://json-schema.org/schema",
   "version": 2,
   "title": "Deploy executor",
-  "description": "",
+  "description": "Deploys project assets to an AWS S3 bucket and invalidates CloudFront distribution cache",
   "type": "object",
   "properties": {
     "s3BucketPath": {
       "type": "string",
-      "description": "S3 BUCKET ROUTE"
+      "description": "The AWS S3 bucket path where the project assets will be deployed. Format: 's3://bucket-name/path'"
     },
     "customPath": {
       "type": "string",
@@ -15,11 +15,11 @@
     },
     "cloudFrontDistributionId": {
       "type": "string",
-      "description": "Cloudfront distribution id for cache invalidation"
+      "description": "The ID of the AWS CloudFront distribution for cache invalidation, ensuring updated assets are served."
     },
     "cloudFrontInvalidationPaths": {
       "type": "array",
-      "description": "Cloudfront path list that must be invalidated in the cache",
+      "description": "List of paths to invalidate in the CloudFront cache. Specify at least one path. Example: ['/index.html']",
       "items": {
         "type": "string"
       },

package/dist/esm/executors/environments/schema.json

@@ -1,8 +1,8 @@
 {
   "$schema": "http://json-schema.org/schema",
   "version": 2,
-  "title": "Environments executor",
-  "description": "",
+  "title": "Environments Executor",
+  "description": "Generates 'environment.ts', 'environment.local.ts', 'environment.prod.ts', and 'environment.staging.ts' files in the 'src/environments' directory if they don't exist, using the project's configuration and package name. Ensures the environments directory exists and standardizes setup for development, local, production, and staging configurations.",
   "type": "object",
   "properties": {},
   "required": []

package/dist/esm/executors/publish/schema.json

@@ -2,16 +2,16 @@
   "$schema": "http://json-schema.org/schema",
   "version": 2,
   "title": "Publish executor",
-  "description": "",
+  "description": "Automates the process of publishing a package to npm, requiring prior npm authentication. It checks if the current version is greater than both the latest published version and the specified tag version. Supports a dry run mode for testing without actual publication.",
   "type": "object",
   "properties": {
     "tag": {
       "type": "string",
-      "description": "Tag name to publish"
+      "description": "The tag name to publish under, used for identifying release channels (e.g., 'alpha', 'beta', 'latest')."
     },
     "dryRun": {
       "type": "boolean",
-      "description": "Indicates whether a test execution should be done without really publishing",
+      "description": "Executes the publish process without actually publishing to npm, allowing for validation and testing of the process.",
       "default": false
     }
   },

package/dist/esm/executors/shared/utils.mjs

@@ -51,10 +51,20 @@ async function runCommand(command, cwd) {
             }
         });
         logger.info(stdout);
-        logger.info(stderr);
+        if (stderr) {
+            logger.error('Error Output:');
+            logger.error(stderr);
+        }
     } catch (error) {
         logger.error(`Unexpected error running command:`);
-        logger.error(error);
+        if (error.stdout) {
+            logger.error('Standard Output:');
+            logger.error(error.stdout);
+        }
+        if (error.stderr) {
+            logger.error('Error Output:');
+            logger.error(error.stderr);
+        }
         throw error;
     }
 }

package/dist/esm/executors/update-executors-file/schema.json

@@ -1,8 +1,8 @@
 {
   "$schema": "http://json-schema.org/schema",
   "version": 2,
-  "title": "UpdateExecutorsFile executor",
-  "description": "",
+  "title": "UpdateExecutorsFile Executor",
+  "description": "Executor for updating paths in the executors.json file, ensuring they point to the correct locations after changes in the project structure.",
   "type": "object",
   "properties": {},
   "required": []

package/dist/esm/node_modules/.pnpm/{@vitejs_plugin-basic-ssl@1.1.0_vite@5.0.12 → @vitejs_plugin-basic-ssl@1.1.0_vite@5.2.10_@types_node@18.19.31_sass@1.75.0_}/node_modules/@vitejs/plugin-basic-ssl/dist/index.mjs

@@ -6,7 +6,7 @@ function viteBasicSslPlugin(options) {
   return {
     name: "vite:basic-ssl",
     async configResolved(config) {
-      const certificate = await getCertificate(options?.certDir ?? (config.cacheDir ?? defaultCacheDir) + "/basic-ssl", options?.name, options?.domains);
+      const certificate = await getCertificate((config.cacheDir ?? defaultCacheDir) + "/basic-ssl", options?.name, options?.domains);
       const https = () => ({ cert: certificate, key: certificate });
       if (config.server.https === void 0 || !!config.server.https) {
         config.server.https = Object.assign({}, config.server.https, https());

package/dist/esm/vitejs/config-builder/plugins.mjs

@@ -17,7 +17,7 @@ import 'crypto';
 import 'fs';
 import 'chalk';
 import 'mri';
-import viteBasicSslPlugin from '../../node_modules/.pnpm/@vitejs_plugin-basic-ssl@1.1.0_vite@5.0.12/node_modules/@vitejs/plugin-basic-ssl/dist/index.mjs';
+import viteBasicSslPlugin from '../../node_modules/.pnpm/@vitejs_plugin-basic-ssl@1.1.0_vite@5.2.10_@types_node@18.19.31_sass@1.75.0_/node_modules/@vitejs/plugin-basic-ssl/dist/index.mjs';
 
 /**
  * Base plugins configuration for apps and libs.

package/executors.json

@@ -3,7 +3,7 @@
     "environments": {
       "implementation": "./dist/cjs/executors/environments/index.cjs",
       "schema": "./dist/cjs/executors/environments/schema.json",
-      "description": "Configure project with custom environments"
+      "description": "Generates 'environment.ts', 'environment.local.ts', 'environment.prod.ts', and 'environment.staging.ts' files in the 'src/environments' directory if they don't exist, using the project's configuration and package name. Ensures the environments directory exists and standardizes setup for development, local, production, and staging configurations"
     },
     "vtex-link": {
       "implementation": "./dist/cjs/executors/vtex-link/index.cjs",
@@ -13,17 +13,17 @@
     "publish": {
       "implementation": "./dist/cjs/executors/publish/index.cjs",
       "schema": "./dist/cjs/executors/publish/schema.json",
-      "description": "publish executor"
+      "description": "Automates the process of publishing a package to npm, requiring prior npm authentication. It checks if the current version is greater than both the latest published version and the specified tag version. Supports a dry run mode for testing without actual publication"
     },
     "update-executors-file": {
       "implementation": "./dist/cjs/executors/update-executors-file/index.cjs",
       "schema": "./dist/cjs/executors/update-executors-file/schema.json",
-      "description": "update-executors-file executor"
+      "description": "Executor for updating paths in the executors.json file, ensuring they point to the correct locations after changes in the project structure"
     },
     "deploy": {
       "implementation": "./dist/cjs/executors/deploy/index.cjs",
       "schema": "./dist/cjs/executors/deploy/schema.json",
-      "description": "deploy executor"
+      "description": "Deploys project assets to an AWS S3 bucket and invalidates CloudFront distribution cache"
     }
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nizza/devkit",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "type": "module",
   "main": "dist/cjs/index.cjs",
   "module": "dist/esm/index.mjs",
@@ -33,22 +33,22 @@
   },
   "devDependencies": {
     "@rollup/plugin-commonjs": "^25.0.7",
-    "@rollup/plugin-json": "^6.0.1",
+    "@rollup/plugin-json": "^6.1.0",
     "@rollup/plugin-node-resolve": "^15.2.3",
     "@types/semver": "^7.5.0",
-    "rollup": "^4.2.0",
+    "rollup": "^4.17.1",
     "rollup-plugin-copy": "^3.5.0",
     "rollup-plugin-delete": "^2.0.0",
     "rollup-plugin-dts-bundle-generator": "^1.4.0",
-    "rollup-plugin-swc3": "^0.10.3"
+    "rollup-plugin-swc3": "^0.11.1"
   },
   "peerDependencies": {
-    "@nx/devkit": "17.0.2",
+    "@nx/devkit": "^19.0.0",
     "@originjs/vite-plugin-commonjs": "^1.0.3",
     "@rollup/plugin-graphql": "^2.0.4",
-    "@vitejs/plugin-react-swc": "^3.4.1",
+    "@vitejs/plugin-react-swc": "3.6.0",
     "rollup-plugin-visualizer": "^5.9.2",
-    "vite": "^4.5.0",
+    "vite": "^5.2.10",
     "vite-plugin-css-injected-by-js": "^3.3.0",
     "vite-plugin-dts": "^3.6.3",
     "vite-tsconfig-paths": "^4.2.1"