From e13d64480503e448ff979641a65dcc2ec487fdf8 Mon Sep 17 00:00:00 2001 From: Roberto Redradix Date: Fri, 1 Sep 2023 16:40:04 +0200 Subject: [PATCH] refactor!(cli): rename pentpot-css-export to penpot-export --- README.md | 20 +++++++++---------- package.json | 4 ++-- packages/demo/package.json | 4 ++-- ...port.config.js => penpot-export.config.js} | 2 +- packages/demo/src/index.html | 2 +- .../.gitignore | 0 .../.prettierignore | 0 .../.prettierrc.json | 0 .../package.json | 6 ++---- .../src/bin/index.ts | 7 ++----- .../adapters/inbound/colorsToCssVariables.ts | 0 .../inbound/pageComponentsToCssClasses.ts | 0 .../inbound/typographyToCssClasses.ts | 0 .../src/lib/api/helpers.ts | 0 .../src/lib/api/index.ts | 0 .../src/lib/api/penpot.ts | 0 .../src/lib/api/types.ts | 0 .../src/lib/config/index.ts | 0 .../src/lib/config/types.ts | 0 .../src/lib/config/validator.ts | 0 .../src/lib/css/helpers.ts | 0 .../src/lib/index.ts | 2 +- .../src/lib/outputters/css.ts | 0 .../src/lib/string.ts | 0 .../src/lib/types.ts | 0 .../tsconfig.json | 0 .../yarn.lock | 0 27 files changed, 21 insertions(+), 26 deletions(-) rename packages/demo/{penpot-css-export.config.js => penpot-export.config.js} (95%) rename packages/{penpot-css-export => penpot-export}/.gitignore (100%) rename packages/{penpot-css-export => penpot-export}/.prettierignore (100%) rename packages/{penpot-css-export => penpot-export}/.prettierrc.json (100%) rename packages/{penpot-css-export => penpot-export}/package.json (85%) rename packages/{penpot-css-export => penpot-export}/src/bin/index.ts (63%) rename packages/{penpot-css-export => penpot-export}/src/lib/adapters/inbound/colorsToCssVariables.ts (100%) rename packages/{penpot-css-export => penpot-export}/src/lib/adapters/inbound/pageComponentsToCssClasses.ts (100%) rename packages/{penpot-css-export => penpot-export}/src/lib/adapters/inbound/typographyToCssClasses.ts (100%) rename packages/{penpot-css-export => penpot-export}/src/lib/api/helpers.ts (100%) rename packages/{penpot-css-export => penpot-export}/src/lib/api/index.ts (100%) rename packages/{penpot-css-export => penpot-export}/src/lib/api/penpot.ts (100%) rename packages/{penpot-css-export => penpot-export}/src/lib/api/types.ts (100%) rename packages/{penpot-css-export => penpot-export}/src/lib/config/index.ts (100%) rename packages/{penpot-css-export => penpot-export}/src/lib/config/types.ts (100%) rename packages/{penpot-css-export => penpot-export}/src/lib/config/validator.ts (100%) rename packages/{penpot-css-export => penpot-export}/src/lib/css/helpers.ts (100%) rename packages/{penpot-css-export => penpot-export}/src/lib/index.ts (98%) rename packages/{penpot-css-export => penpot-export}/src/lib/outputters/css.ts (100%) rename packages/{penpot-css-export => penpot-export}/src/lib/string.ts (100%) rename packages/{penpot-css-export => penpot-export}/src/lib/types.ts (100%) rename packages/{penpot-css-export => penpot-export}/tsconfig.json (100%) rename packages/{penpot-css-export => penpot-export}/yarn.lock (100%) diff --git a/README.md b/README.md index 5eff51b..9584e8b 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,24 @@ -# penpot-css-export +# penpot-export ## Description -`penpot-css-export` is an npm tool designed to export your design components created in Penpot directly to CSS files. With a simple `pce` command, you can convert your designs into ready-to-use CSS classes. +`penpot-export` is an npm tool designed to export your design components created in Penpot directly to CSS files. With a simple `pce` command, you can convert your designs into ready-to-use CSS classes. ## Installation -To install `penpot-css-export`, simply run: +To install `penpot-export`, simply run: ```bash # npm -npm install penpot-css-export --save-dev +npm install penpot-export --save-dev # yarn -yarn add penpot-css-export +yarn add penpot-export ``` ## Configuration -Before you can use `penpot-css-export`, you need to set up a [`penpot-css-export.config.js`](./packages/demo/penpot-css-export.config.js) file at the root of your project. This file defines how your Penpot designs will be exported. +Before you can use `penpot-export`, you need to set up a [`penpot-export.config.js`](./packages/demo/penpot-export.config.js) file at the root of your project. This file defines how your Penpot designs will be exported. Configuration example: @@ -26,7 +26,7 @@ Configuration example: require('dotenv').config() /** - * @type {import('penpot-css-export').UserConfig} + * @type {import('penpot-export').UserConfig} */ const config = { instance: process.env.PENPOT_BASE_URL || undefined, @@ -62,7 +62,7 @@ module.exports = config ## Usage -Once you've set up the `penpot-css-export.config.js` file, simply run the following command to generate your CSS files: +Once you've set up the `penpot-export.config.js` file, simply run the following command to generate your CSS files: ```bash pce @@ -82,12 +82,12 @@ This project utilizes [Yarn Workspaces](https://classic.yarnpkg.com/lang/en/docs ### Package Structure -- [**packages/penpot-css-export**](./packages/penpot-css-export/): This package contains the CLI tool written in TypeScript. This is where the primary tool code resides. +- [**packages/penpot-export**](./packages/penpot-export/): This package contains the CLI tool written in TypeScript. This is where the primary tool code resides. - [**packages/demo**](./packages/demo/): This package serves as a demonstration environment. You can run the `pce` command within this package to test out implementations in development. ### Local Development -For the "demo" package to utilize the local version of the `pce` command you're developing, it's essential first to compile the TypeScript code from the "penpot-css-export" package. +For the "demo" package to utilize the local version of the `pce` command you're developing, it's essential first to compile the TypeScript code from the "penpot-export" package. ### Handy Commands diff --git a/package.json b/package.json index 61d9e14..6405708 100644 --- a/package.json +++ b/package.json @@ -5,8 +5,8 @@ "packages/*" ], "scripts": { - "dev": "npm run dev -w penpot-css-export", - "build": "npm run build -w penpot-css-export", + "dev": "npm run dev -w penpot-export", + "build": "npm run build -w penpot-export", "demo": "npm run generate-css -w demo" } } diff --git a/packages/demo/package.json b/packages/demo/package.json index 1fc6595..4841713 100644 --- a/packages/demo/package.json +++ b/packages/demo/package.json @@ -3,10 +3,10 @@ "private": true, "version": "0.0.0", "scripts": { - "generate-css": "pce" + "generate-css": "penpot-export" }, "dependencies": { - "penpot-css-export": "0.0.0" + "penpot-export": "0.0.0" }, "devDependencies": { "dotenv": "^16.3.1" diff --git a/packages/demo/penpot-css-export.config.js b/packages/demo/penpot-export.config.js similarity index 95% rename from packages/demo/penpot-css-export.config.js rename to packages/demo/penpot-export.config.js index 6d76c35..5c81935 100644 --- a/packages/demo/penpot-css-export.config.js +++ b/packages/demo/penpot-export.config.js @@ -5,7 +5,7 @@ if (typeof process.env.PENPOT_ACCESS_TOKEN !== 'string') { } /** - * @type {import('penpot-css-export').UserConfig} + * @type {import('penpot-export').UserConfig} */ const config = { instance: process.env.PENPOT_BASE_URL || undefined, diff --git a/packages/demo/src/index.html b/packages/demo/src/index.html index 4428746..17992aa 100644 --- a/packages/demo/src/index.html +++ b/packages/demo/src/index.html @@ -1,6 +1,6 @@ - penpot-css-export demo + penpot-export demo diff --git a/packages/penpot-css-export/.gitignore b/packages/penpot-export/.gitignore similarity index 100% rename from packages/penpot-css-export/.gitignore rename to packages/penpot-export/.gitignore diff --git a/packages/penpot-css-export/.prettierignore b/packages/penpot-export/.prettierignore similarity index 100% rename from packages/penpot-css-export/.prettierignore rename to packages/penpot-export/.prettierignore diff --git a/packages/penpot-css-export/.prettierrc.json b/packages/penpot-export/.prettierrc.json similarity index 100% rename from packages/penpot-css-export/.prettierrc.json rename to packages/penpot-export/.prettierrc.json diff --git a/packages/penpot-css-export/package.json b/packages/penpot-export/package.json similarity index 85% rename from packages/penpot-css-export/package.json rename to packages/penpot-export/package.json index 3a14150..ad33d88 100644 --- a/packages/penpot-css-export/package.json +++ b/packages/penpot-export/package.json @@ -1,5 +1,5 @@ { - "name": "penpot-css-export", + "name": "penpot-export", "version": "0.0.0", "license": "UNLICENSED", "main": "dist/bin/index.js", @@ -7,9 +7,7 @@ "files": [ "dist" ], - "bin": { - "pce": "./dist/bin/index.js" - }, + "bin": "./dist/bin/index.js", "scripts": { "build": "tsc", "format": "prettier -w .", diff --git a/packages/penpot-css-export/src/bin/index.ts b/packages/penpot-export/src/bin/index.ts similarity index 63% rename from packages/penpot-css-export/src/bin/index.ts rename to packages/penpot-export/src/bin/index.ts index ee64252..57cb422 100644 --- a/packages/penpot-css-export/src/bin/index.ts +++ b/packages/penpot-export/src/bin/index.ts @@ -5,15 +5,12 @@ import path from 'path' import { generateCssFromConfig } from '../lib' const rootProjectPath = fs.realpathSync(process.cwd()) -const configFilePath = path.resolve( - rootProjectPath, - 'penpot-css-export.config.js', -) +const configFilePath = path.resolve(rootProjectPath, 'penpot-export.config.js') const exists = fs.existsSync(configFilePath) if (!exists) { throw new Error( - 'penpot-css-export: Config file not found. Check if file penpot-css-export.config.js exists at root.', + 'penpot-export: Config file not found. Check if file penpot-export.config.js exists at root.', ) } diff --git a/packages/penpot-css-export/src/lib/adapters/inbound/colorsToCssVariables.ts b/packages/penpot-export/src/lib/adapters/inbound/colorsToCssVariables.ts similarity index 100% rename from packages/penpot-css-export/src/lib/adapters/inbound/colorsToCssVariables.ts rename to packages/penpot-export/src/lib/adapters/inbound/colorsToCssVariables.ts diff --git a/packages/penpot-css-export/src/lib/adapters/inbound/pageComponentsToCssClasses.ts b/packages/penpot-export/src/lib/adapters/inbound/pageComponentsToCssClasses.ts similarity index 100% rename from packages/penpot-css-export/src/lib/adapters/inbound/pageComponentsToCssClasses.ts rename to packages/penpot-export/src/lib/adapters/inbound/pageComponentsToCssClasses.ts diff --git a/packages/penpot-css-export/src/lib/adapters/inbound/typographyToCssClasses.ts b/packages/penpot-export/src/lib/adapters/inbound/typographyToCssClasses.ts similarity index 100% rename from packages/penpot-css-export/src/lib/adapters/inbound/typographyToCssClasses.ts rename to packages/penpot-export/src/lib/adapters/inbound/typographyToCssClasses.ts diff --git a/packages/penpot-css-export/src/lib/api/helpers.ts b/packages/penpot-export/src/lib/api/helpers.ts similarity index 100% rename from packages/penpot-css-export/src/lib/api/helpers.ts rename to packages/penpot-export/src/lib/api/helpers.ts diff --git a/packages/penpot-css-export/src/lib/api/index.ts b/packages/penpot-export/src/lib/api/index.ts similarity index 100% rename from packages/penpot-css-export/src/lib/api/index.ts rename to packages/penpot-export/src/lib/api/index.ts diff --git a/packages/penpot-css-export/src/lib/api/penpot.ts b/packages/penpot-export/src/lib/api/penpot.ts similarity index 100% rename from packages/penpot-css-export/src/lib/api/penpot.ts rename to packages/penpot-export/src/lib/api/penpot.ts diff --git a/packages/penpot-css-export/src/lib/api/types.ts b/packages/penpot-export/src/lib/api/types.ts similarity index 100% rename from packages/penpot-css-export/src/lib/api/types.ts rename to packages/penpot-export/src/lib/api/types.ts diff --git a/packages/penpot-css-export/src/lib/config/index.ts b/packages/penpot-export/src/lib/config/index.ts similarity index 100% rename from packages/penpot-css-export/src/lib/config/index.ts rename to packages/penpot-export/src/lib/config/index.ts diff --git a/packages/penpot-css-export/src/lib/config/types.ts b/packages/penpot-export/src/lib/config/types.ts similarity index 100% rename from packages/penpot-css-export/src/lib/config/types.ts rename to packages/penpot-export/src/lib/config/types.ts diff --git a/packages/penpot-css-export/src/lib/config/validator.ts b/packages/penpot-export/src/lib/config/validator.ts similarity index 100% rename from packages/penpot-css-export/src/lib/config/validator.ts rename to packages/penpot-export/src/lib/config/validator.ts diff --git a/packages/penpot-css-export/src/lib/css/helpers.ts b/packages/penpot-export/src/lib/css/helpers.ts similarity index 100% rename from packages/penpot-css-export/src/lib/css/helpers.ts rename to packages/penpot-export/src/lib/css/helpers.ts diff --git a/packages/penpot-css-export/src/lib/index.ts b/packages/penpot-export/src/lib/index.ts similarity index 98% rename from packages/penpot-css-export/src/lib/index.ts rename to packages/penpot-export/src/lib/index.ts index 4b1fa28..7dec05e 100644 --- a/packages/penpot-css-export/src/lib/index.ts +++ b/packages/penpot-export/src/lib/index.ts @@ -12,7 +12,7 @@ export async function generateCssFromConfig( ) { if (!validateUserConfig(userConfig)) throw new Error( - 'Error validating user config. This is probably an error in penpot-css-export code.', + 'Error validating user config. This is probably an error in penpot-export code.', ) const config = normalizePenpotExportUserConfig(userConfig) diff --git a/packages/penpot-css-export/src/lib/outputters/css.ts b/packages/penpot-export/src/lib/outputters/css.ts similarity index 100% rename from packages/penpot-css-export/src/lib/outputters/css.ts rename to packages/penpot-export/src/lib/outputters/css.ts diff --git a/packages/penpot-css-export/src/lib/string.ts b/packages/penpot-export/src/lib/string.ts similarity index 100% rename from packages/penpot-css-export/src/lib/string.ts rename to packages/penpot-export/src/lib/string.ts diff --git a/packages/penpot-css-export/src/lib/types.ts b/packages/penpot-export/src/lib/types.ts similarity index 100% rename from packages/penpot-css-export/src/lib/types.ts rename to packages/penpot-export/src/lib/types.ts diff --git a/packages/penpot-css-export/tsconfig.json b/packages/penpot-export/tsconfig.json similarity index 100% rename from packages/penpot-css-export/tsconfig.json rename to packages/penpot-export/tsconfig.json diff --git a/packages/penpot-css-export/yarn.lock b/packages/penpot-export/yarn.lock similarity index 100% rename from packages/penpot-css-export/yarn.lock rename to packages/penpot-export/yarn.lock