@terrazzo/cli 0.0.7 → 0.0.8

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Drew Powers
+Copyright (c) 2024 Drew Powers
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

package/bin/cli.js

@@ -80,11 +80,17 @@ export default async function main() {
     }
     configPath = resolveConfig(flags.config);
   }
-  let config;
-  try {
-    config = (await import(resolveConfig(configPath))).default;
-  } catch (err) {
-    printErrors(err.message || err);
+  let config = { tokens: [new URL('./tokens.json', cwd)], outDir: new URL('./tokens/', cwd), plugins: [] };
+  const resolvedConfigPath = resolveConfig(configPath);
+  if (resolvedConfigPath) {
+    try {
+      config = (await import(resolvedConfigPath)).default;
+    } catch (err) {
+      printErrors(err.message || err);
+      process.exit(1);
+    }
+  } else if (cmd !== 'init' && cmd !== 'check') {
+    printErrors('No config file found. Create one with `npx terrazzo init`.');
     process.exit(1);
   }
 
@@ -154,54 +160,39 @@ export default async function main() {
       break;
     }
     case 'check': {
-      const rawSchema = await loadTokens(config.tokens);
-      const filepath = config.tokens[0];
+      const rawSchema = await loadTokens(flags._[0] ? [resolveTokenPath(flags._[0])] : config.tokens);
+      const filepath = flags._[0] || config.tokens[0];
       console.log(pc.underline(filepath.protocol === 'file:' ? fileURLToPath(filepath) : filepath));
-      const { errors, warnings } = parse(rawSchema, config); // will throw if errors
-      if (errors || warnings) {
-        printErrors(errors);
-        printWarnings(warnings);
-        process.exit(1);
-      }
-      printSuccess(`no errors ${time(start)}`);
+      await parse(rawSchema, { config }); // will throw if errors
+      printSuccess(`No errors ${time(start)}`);
       break;
     }
     case 'lint': {
       if (!Array.isArray(config.plugins) || !config.plugins.length) {
-        printErrors(`✘  No plugins defined! Add some in ${configPath || 'tokens.config.js'}`);
+        printErrors(`No plugins defined! Add some in ${configPath || 'tokens.config.js'}`);
         process.exit(1);
       }
 
-      const rawSchema = await loadTokens(config.tokens);
-      const parseResult = parse(rawSchema, config); // will throw if errors
+      const rawSchema = await loadTokens(flags._[0] ? [resolveTokenPath(flags._[0])] : config.tokens);
+      const parseResult = await parse(rawSchema, { config }); // will throw if errors
+
+      // TODO
 
-      if (parseResult.errors) {
-        printErrors(parseResult.errors);
-        printWarnings(parseResult.warnings);
-        process.exit(1);
-      }
-      if (parseResult.warnings) {
-        printWarnings(parseResult.warnings);
-      }
-      const lintResult = await lint({ config, tokens: parseResult.result.tokens, rawSchema, warnIfNoPlugins: true });
-      if (lintResult.errors) {
-        printErrors(lintResult.errors);
-        printWarnings(lintResult.warnings);
-        process.exit(1);
-      }
-      if (lintResult.warnings) {
-        printWarnings(lintResult.warnings);
-      } else {
-        printSuccess(`all checks passed ${time(start)}`);
-      }
       break;
     }
     case 'init': {
-      if (fs.existsSync(config.tokens)) {
-        throw new Error(`${config.tokens} already exists`);
+      if (
+        !fs.existsSync(new URL('./terrazzo.config.js', cwd)) &&
+        !fs.existsSync(new URL('./terrazzo.config.mjs', cwd)) &&
+        !fs.existsSync(new URL('./terrazzo.config.cjs', cwd))
+      ) {
+        fs.cpSync(new URL('../terrazzo.config.js', import.meta.url), new URL('./terrazzo.config.js', cwd));
+        printSuccess('terrazzo.config.js created');
+      }
+      if (!fs.existsSync(config.tokens[0])) {
+        fs.cpSync(new URL('../tokens-example.json', import.meta.url), new URL(config?.tokens, cwd));
+        printSuccess(`${config.tokens} created ${time(start)}`);
       }
-      fs.cpSync(new URL('../tokens-example.json', import.meta.url), new URL(config.tokens, cwd));
-      printSuccess(`${config.tokens} created ${time(start)}`);
       break;
     }
     default: {
@@ -232,8 +223,8 @@ function showHelp() {
       --out [path]  Specify converted tokens.json output
 
   [options]
-    --help         Show this message
-    --config, -c   Path to config (default: ./tokens.config.js)
+    --help          Show this message
+    --config, -c    Path to config (default: ./tokens.config.js)
 `);
 }
 
@@ -317,6 +308,20 @@ function resolveConfig(filename) {
   }
 }
 
+/** Resolve tokens.json path (for lint command) */
+function resolveTokenPath(filepath) {
+  const tokensPath = new URL(filepath, cwd);
+  if (!fs.existsSync(tokensPath)) {
+    printErrors(`Could not locate ${filepath}. Does the file exist?`);
+    process.exit(1);
+  }
+  if (!fs.statSync(tokensPath).isFile()) {
+    printErrors(`Expected JSON or YAML file, received ${filepath}.`);
+    process.exit(1);
+  }
+  return tokensPath;
+}
+
 /** Print time elapsed */
 function time(start) {
   const diff = performance.now() - start;

package/package.json

@@ -1,18 +1,17 @@
 {
   "name": "@terrazzo/cli",
+  "version": "0.0.8",
   "description": "CLI for managing design tokens using the Design Tokens Community Group (DTCG) standard and generating code for any platform via plugins.",
-  "version": "0.0.7",
+  "type": "module",
   "author": {
     "name": "Drew Powers",
     "email": "drew@pow.rs"
   },
   "keywords": [
     "design tokens",
-    "design tokens community group",
-    "design tokens format module",
     "dtcg",
     "cli",
-    "w3c design tokens",
+    "w3c",
     "design system",
     "typescript",
     "sass",
@@ -20,12 +19,14 @@
     "style tokens",
     "style system"
   ],
-  "engines": {
-    "node": ">=18.0.0"
+  "main": "./dist/index.js",
+  "homepage": "https://terrazzoapp.com/docs/cli",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/terrazzoapp/terrazzo.git",
+    "directory": "./packages/cli/"
   },
   "license": "MIT",
-  "type": "module",
-  "main": "./dist/index.js",
   "bin": {
     "tz": "bin/cli.js",
     "terrazzo": "bin/cli.js"
@@ -36,12 +37,12 @@
     "merge-anything": "^5.1.7",
     "picocolors": "^1.0.1",
     "yargs-parser": "^21.1.1",
-    "@terrazzo/parser": "^0.0.7",
-    "@terrazzo/token-tools": "^0.0.3"
+    "@terrazzo/parser": "^0.0.8",
+    "@terrazzo/token-tools": "^0.0.4"
   },
   "devDependencies": {
-    "@types/node": "^20.14.2",
-    "execa": "^8.0.1"
+    "@types/node": "^20.14.9",
+    "execa": "^9.3.0"
   },
   "scripts": {
     "build": "pnpm run build:clean && pnpm run build:ts",

package/terrazzo.config.js

@@ -0,0 +1,11 @@
+/** @type {import('@terrazzo/cli').Config} */
+export default {
+  tokens: ['tokens.json'],
+  outDir: './tokens/',
+  plugins: [
+    /** @see https://terrazzo.app/docs/cli/integrations */
+  ],
+  lint: {
+    /** @see https://terrazzo.app/docs/cli/linting */
+  },
+};