piral-cli 1.1.0-beta.5790 → 1.1.0-beta.5795

package/lib/rules/pilet-has-non-conflicting-css.d.ts

@@ -1,6 +1,16 @@
 import { PiletRuleContext } from '../types';
-export type Options = 'suggest' | 'required' | 'ignore';
+export type Options = number;
 /**
- * Checks if the pilet has some CSS rules that might conflict with other pilets.
+ * Checks if a pilet might cause a CSS conflict. A score of 100 means that
+ * there is the least chance of a CSS conflict, while a score of 0 means that
+ * a CSS conflict is most likely.
+ *
+ * Negative values yield a warning if the CSS score is below the given number.
+ *
+ * Positive values yield an error if the CSS score is below the given number.
+ *
+ * A value of 0 turns this validation off.
+ *
+ * By default, a pilet's stylesheet having a CSS score of below 50 will result in a warning.
  */
 export default function (context: PiletRuleContext, options?: Options): Promise<void>;

package/lib/rules/pilet-has-non-conflicting-css.js

@@ -9,15 +9,62 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+const path_1 = require("path");
 const css_conflict_inspector_1 = require("css-conflict-inspector");
+const common_1 = require("../common");
+function getPiletCssPaths(main, baseDir) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const paths = [main, `dist/${main}`, `${main}/index.js`, `dist/${main}/index.js`, 'index.js', 'dist/index.js'];
+        for (const path of paths) {
+            const outDir = (0, path_1.dirname)((0, path_1.resolve)(baseDir, path));
+            const exists = yield (0, common_1.checkExists)(outDir);
+            if (exists) {
+                const files = yield (0, common_1.getFileNames)(outDir);
+                return files.filter((m) => m.endsWith('.css')).map((m) => (0, path_1.resolve)(outDir, m));
+            }
+        }
+        return [];
+    });
+}
+function getCssScore(dir, file) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const content = yield (0, common_1.readText)(dir, file);
+        const result = (0, css_conflict_inspector_1.analyzeCss)(content);
+        return result.score;
+    });
+}
 /**
- * Checks if the pilet has some CSS rules that might conflict with other pilets.
+ * Checks if a pilet might cause a CSS conflict. A score of 100 means that
+ * there is the least chance of a CSS conflict, while a score of 0 means that
+ * a CSS conflict is most likely.
+ *
+ * Negative values yield a warning if the CSS score is below the given number.
+ *
+ * Positive values yield an error if the CSS score is below the given number.
+ *
+ * A value of 0 turns this validation off.
+ *
+ * By default, a pilet's stylesheet having a CSS score of below 50 will result in a warning.
  */
-function default_1(context, options = 'suggest') {
+function default_1(context, options = -50) {
     return __awaiter(this, void 0, void 0, function* () {
-        if (options !== 'ignore') {
-            //TODO
-            const result = (0, css_conflict_inspector_1.analyzeCss)('');
+        if (options !== 0 && typeof options === 'number') {
+            const threshold = Math.abs(options);
+            const { main } = context.piletPackage;
+            const paths = yield getPiletCssPaths(main, context.root);
+            for (const path of paths) {
+                const dir = (0, path_1.dirname)(path);
+                const file = (0, path_1.basename)(path);
+                const score = yield getCssScore(dir, file);
+                if (score < threshold) {
+                    const notify = options > 0 ? context.error : context.warning;
+                    notify(`
+The CSS in "${file}" might lead to conflicts.
+  Minimum: ${threshold} points.
+  Received: ${score} points.
+`);
+                }
+            }
         }
     });
 }

package/lib/rules/pilet-has-non-conflicting-css.js.map

@@ -1 +1 @@
-{"version":3,"file":"pilet-has-non-conflicting-css.js","sourceRoot":"","sources":["../../src/rules/pilet-has-non-conflicting-css.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,mEAAoD;AAKpD;;GAEG;AACH,mBAA+B,OAAyB,EAAE,UAAmB,SAAS;;QACpF,IAAI,OAAO,KAAK,QAAQ,EAAE;YACxB,MAAM;YACN,MAAM,MAAM,GAAG,IAAA,mCAAU,EAAC,EAAE,CAAC,CAAC;SAC/B;IACH,CAAC;CAAA;AALD,4BAKC"}
+{"version":3,"file":"pilet-has-non-conflicting-css.js","sourceRoot":"","sources":["../../src/rules/pilet-has-non-conflicting-css.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,+BAAkD;AAClD,mEAAoD;AACpD,sCAAgE;AAKhE,SAAe,gBAAgB,CAAC,IAAY,EAAE,OAAe;;QAC3D,MAAM,KAAK,GAAG,CAAC,IAAI,EAAE,QAAQ,IAAI,EAAE,EAAE,GAAG,IAAI,WAAW,EAAE,QAAQ,IAAI,WAAW,EAAE,UAAU,EAAE,eAAe,CAAC,CAAC;QAE/G,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACxB,MAAM,MAAM,GAAG,IAAA,cAAO,EAAC,IAAA,cAAO,EAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC;YAC/C,MAAM,MAAM,GAAG,MAAM,IAAA,oBAAW,EAAC,MAAM,CAAC,CAAC;YAEzC,IAAI,MAAM,EAAE;gBACV,MAAM,KAAK,GAAG,MAAM,IAAA,qBAAY,EAAC,MAAM,CAAC,CAAC;gBACzC,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAA,cAAO,EAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;aAC/E;SACF;QAED,OAAO,EAAE,CAAC;IACZ,CAAC;CAAA;AAED,SAAe,WAAW,CAAC,GAAW,EAAE,IAAY;;QAClD,MAAM,OAAO,GAAG,MAAM,IAAA,iBAAQ,EAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAC1C,MAAM,MAAM,GAAG,IAAA,mCAAU,EAAC,OAAO,CAAC,CAAC;QACnC,OAAO,MAAM,CAAC,KAAK,CAAC;IACtB,CAAC;CAAA;AAED;;;;;;;;;;;;GAYG;AACH,mBAA+B,OAAyB,EAAE,UAAmB,CAAC,EAAE;;QAC9E,IAAI,OAAO,KAAK,CAAC,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;YAChD,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YACpC,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC,YAAY,CAAC;YACtC,MAAM,KAAK,GAAG,MAAM,gBAAgB,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;YAEzD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;gBACxB,MAAM,GAAG,GAAG,IAAA,cAAO,EAAC,IAAI,CAAC,CAAC;gBAC1B,MAAM,IAAI,GAAG,IAAA,eAAQ,EAAC,IAAI,CAAC,CAAC;gBAC5B,MAAM,KAAK,GAAG,MAAM,WAAW,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;gBAE3C,IAAI,KAAK,GAAG,SAAS,EAAE;oBACrB,MAAM,MAAM,GAAG,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;oBAC7D,MAAM,CACJ;cACI,IAAI;aACL,SAAS;cACR,KAAK;CAClB,CACQ,CAAC;iBACH;aACF;SACF;IACH,CAAC;CAAA;AAvBD,4BAuBC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "piral-cli",
-  "version": "1.1.0-beta.5790",
+  "version": "1.1.0-beta.5795",
   "description": "The standard CLI for creating and building a Piral instance or a Pilet.",
   "keywords": [
     "portal",
@@ -74,12 +74,12 @@
     "tar": "^4.4.8"
   },
   "dependencies": {
-    "css-conflict-inspector": "^0.1.1",
+    "css-conflict-inspector": "^0.2.0",
     "dets": "^0.13.0",
     "kras": "^0.15.4",
     "rimraf": "^3.0.0",
     "typescript": "^5.0.0",
     "yargs": "^15.0.0"
   },
-  "gitHead": "72d5d80ca6a0265ae77d03bd2fdea1ad7e0101b6"
+  "gitHead": "da5f369c6bc3558a4a2013e121b5e622e39a0a54"
 }

package/src/rules/pilet-has-non-conflicting-css.ts

@@ -1,14 +1,66 @@
+import { basename, dirname, resolve } from 'path';
 import { analyzeCss } from 'css-conflict-inspector';
+import { checkExists, getFileNames, readText } from '../common';
 import { PiletRuleContext } from '../types';
 
-export type Options = 'suggest' | 'required' | 'ignore';
+export type Options = number;
+
+async function getPiletCssPaths(main: string, baseDir: string) {
+  const paths = [main, `dist/${main}`, `${main}/index.js`, `dist/${main}/index.js`, 'index.js', 'dist/index.js'];
+
+  for (const path of paths) {
+    const outDir = dirname(resolve(baseDir, path));
+    const exists = await checkExists(outDir);
+
+    if (exists) {
+      const files = await getFileNames(outDir);
+      return files.filter((m) => m.endsWith('.css')).map((m) => resolve(outDir, m));
+    }
+  }
+
+  return [];
+}
+
+async function getCssScore(dir: string, file: string) {
+  const content = await readText(dir, file);
+  const result = analyzeCss(content);
+  return result.score;
+}
 
 /**
- * Checks if the pilet has some CSS rules that might conflict with other pilets.
+ * Checks if a pilet might cause a CSS conflict. A score of 100 means that
+ * there is the least chance of a CSS conflict, while a score of 0 means that
+ * a CSS conflict is most likely.
+ *
+ * Negative values yield a warning if the CSS score is below the given number.
+ *
+ * Positive values yield an error if the CSS score is below the given number.
+ *
+ * A value of 0 turns this validation off.
+ *
+ * By default, a pilet's stylesheet having a CSS score of below 50 will result in a warning.
  */
-export default async function (context: PiletRuleContext, options: Options = 'suggest') {
-  if (options !== 'ignore') {
-    //TODO
-    const result = analyzeCss('');
+export default async function (context: PiletRuleContext, options: Options = -50) {
+  if (options !== 0 && typeof options === 'number') {
+    const threshold = Math.abs(options);
+    const { main } = context.piletPackage;
+    const paths = await getPiletCssPaths(main, context.root);
+
+    for (const path of paths) {
+      const dir = dirname(path);
+      const file = basename(path);
+      const score = await getCssScore(dir, file);
+
+      if (score < threshold) {
+        const notify = options > 0 ? context.error : context.warning;
+        notify(
+          `
+The CSS in "${file}" might lead to conflicts.
+  Minimum: ${threshold} points.
+  Received: ${score} points.
+`,
+        );
+      }
+    }
   }
 }