@fishawack/lab-env 4.39.0-beta.7 → 4.39.0-beta.8

package/.prettierignore

@@ -10,6 +10,14 @@ coverage
 dist
 ios
 android
+_Output
+_Packages
+.cache
+.husky
+**/generated/**/*
+_Zips
+_Pdfs
+_Build/content
 package-lock.json
 composer.lock
 CHANGELOG.md

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 ## Changelog
 
+### 4.39.0-beta.8 (2025-05-23)
+
+#### Features
+
+* added fix flag to lint command ([fc4e016](https://bitbucket.org/fishawackdigital/lab-env/commits/fc4e0162e1247b68b4e5558f5bb41ef55a7f4f72))
+* added stylelint ([3780f92](https://bitbucket.org/fishawackdigital/lab-env/commits/3780f92cc693f92283e8cc70a92cc164c70d661c))
+* copy stylintconfig into project root ([10039a0](https://bitbucket.org/fishawackdigital/lab-env/commits/10039a028106b1212f752bee4c5bbce211b474ae))
+* disable id pattern in stylelint ([edd1f87](https://bitbucket.org/fishawackdigital/lab-env/commits/edd1f876a7877e660991b2c175dc11d06f4187ec))
+* force flag can now be used to bypass diagnose ([78cf860](https://bitbucket.org/fishawackdigital/lab-env/commits/78cf8602e40879344e30e2bc0d06b310aec2e099))
+* major version bump of fw diagnose ([989a0d1](https://bitbucket.org/fishawackdigital/lab-env/commits/989a0d1a04f3e8b40bb82a4c5ddb25f59935445c))
+
+#### Bug Fixes
+
+* added more paths to ignored paths for linters ([a6097ec](https://bitbucket.org/fishawackdigital/lab-env/commits/a6097ec4665f8b0c738d264eb19fa24a638fb6e5))
+* dont error when no matching files on eslint ([069422c](https://bitbucket.org/fishawackdigital/lab-env/commits/069422c86e906cdfa9719919fc441155b9bf0edc))
+* ignore handlebars helpers as theyll be gone soon and add some global ignores ([e42e05e](https://bitbucket.org/fishawackdigital/lab-env/commits/e42e05e669549ef3087480d8c33fb837c96cc3bc))
+* ignore variable pattern in stylelint ([7809024](https://bitbucket.org/fishawackdigital/lab-env/commits/78090249755c6871ef6f54b77cd55dcea7ca7d38))
+* run style lint first so other linters dont explode with prettier fixes ([e7e16fc](https://bitbucket.org/fishawackdigital/lab-env/commits/e7e16fc4a9b28fc6613f44fdf10b334d3c08b730))
+* stylelint now uses global path ([90d280e](https://bitbucket.org/fishawackdigital/lab-env/commits/90d280e6cea3f621ad49aab6e4b482a4f9e4c053))
+* update stylint paths as it ignores files not directories ([d3e125b](https://bitbucket.org/fishawackdigital/lab-env/commits/d3e125ba9d6ba158d5d210bafc4928bbc22ad448))
+* when running tests via CI/CD diagnose command will be ignored ([b9b9757](https://bitbucket.org/fishawackdigital/lab-env/commits/b9b97579376c87e3fa8a84eed14f4105da397589))
+
 ### 4.39.0-beta.7 (2025-05-21)
 
 #### Features

package/README.md

@@ -204,6 +204,52 @@ docker volume rm boilerplate_node_modules
 
 ## Migrating
 
+### 5.0.0
+
+Version 5 introduced linting and code styling to projects.
+
+#### Re-diagnose
+
+These linters are installed globally via the diagnose command which resulted in a major diagnose version being set forcing users to re-run the command.
+
+```bash
+fw diagnose
+```
+
+#### New ignore paths
+
+Add the following files to your existing projects `.gitignore` file
+
+```
+.husky
+.commitlintrc.json
+.prettierrc.js
+.prettierignore
+.editorconfig
+eslint.config.js
+stylelint.config.js
+```
+
+#### Disabling commithooks
+
+For existing projects where fixing all the linting errors is unreasonable, the developers will need to adjust and commit a couple of files to skip the mandatory git hooks that fire on git push commands.
+
+1. Remove `.husky` from the `.gitignore`
+
+2. Edit the `.husky/pre-push` file
+
+```bash
+# Runs js css php style linters
+fw lint
+
+# Only runs the code style linter
+fw lint style
+```
+
+3. Ensure the `.husky` folder is commited into version control.
+
+> Disabling linters should be a temporary solution. It's important that all projects aim to re-enable all linters at some point in the future as the CI/CD will eventually fail builds for not adhereing to linting rules.
+
 ### 2.0.0
 
 Wordpress repo's are now structured slightly differently to better match laravel, drupal and craftcms setups. Follow these steps to upgrade a wordpress build and get lab-env working again.

package/_Test/provision.js

@@ -9,7 +9,7 @@ describe("provision", () => {
     let config;
     let repo = "lab-env-test-suite";
     let account = "fishawack";
-    let branch = "test";
+    let branch = "development";
     let name = aws.slug(repo, account, branch);
 
     describe("static", () => {
@@ -44,7 +44,7 @@ describe("provision", () => {
                 name,
                 account,
                 repo,
-                "development",
+                branch,
                 config.cloudfront,
             );
         });
@@ -62,7 +62,7 @@ describe("provision", () => {
                 [],
                 [],
                 repo,
-                "development",
+                branch,
                 "wordpress",
             );
         });
@@ -74,7 +74,7 @@ describe("provision", () => {
         });
 
         after(async () => {
-            await aws.fullstackTerminate(repo, account, repo, "development");
+            await aws.fullstackTerminate(repo, account, repo, branch);
 
             execSync(`rm -rf .elasticbeanstalk`, {
                 encoding: "utf8",

package/cli.js

@@ -58,7 +58,6 @@ const args = hideBin(process.argv);
             "connect",
             "execute",
             "lint",
-            "pretty",
         );
 
         if (_.config.preset === "permanent") {

package/commands/create/libs/vars.js

@@ -81,13 +81,17 @@ module.exports.globalModules = [
     { package: "prettier", version: "3" },
     { package: "@prettier/plugin-php", version: "0" },
     // ESLINT
-    { package: "@eslint/js", version: "9.27.0" },
-    { package: "eslint-config-prettier", version: "10.1.5" },
-    { package: "eslint-plugin-import", version: "2.31.0" },
-    { package: "eslint-plugin-prettier", version: "5.4.0" },
-    { package: "eslint-plugin-vue", version: "10.1.0" },
-    { package: "eslint", version: "9.27.0" },
-    { package: "globals", version: "16.1.0" },
+    { package: "@eslint/js", version: "9" },
+    { package: "eslint-config-prettier", version: "10" },
+    { package: "eslint-plugin-import", version: "2" },
+    { package: "eslint-plugin-prettier", version: "5" },
+    { package: "eslint-plugin-vue", version: "10" },
+    { package: "eslint", version: "9" },
+    { package: "globals", version: "16" },
+    // STYLELINT
+    { package: "stylelint", version: "16" },
+    { package: "stylelint-config-standard-scss", version: "15" },
+    { package: "stylelint-prettier", version: "5" },
 ];
 
 // User presets

package/commands/lint.js

@@ -10,14 +10,29 @@ module.exports = [
             describe: "linters to run",
             default: "js css php style",
         });
+
+        yargs.option("fix", {
+            describe: "Attempt to fix issues",
+            type: "boolean",
+        });
     },
     (argv) => {
+        if (argv.linters.includes("style")) {
+            execSync(`prettier ${argv.fix ? "--write" : "--check"} .`, _.opts);
+        }
+
         if (argv.linters.includes("js")) {
-            execSync("eslint '**/*.{js,vue}'", _.opts);
+            execSync(
+                `eslint '**/*.{js,vue}' --no-error-on-unmatched-pattern${argv.fix ? " --fix" : ""}`,
+                _.opts,
+            );
         }
 
-        if (argv.linters.includes("style")) {
-            execSync("prettier --check .", _.opts);
+        if (argv.linters.includes("css")) {
+            execSync(
+                `stylelint '**/*.{scss,css}' --allow-empty-input${argv.fix ? " --fix" : ""}`,
+                _.opts,
+            );
         }
     },
 ];

package/eslint.config.js

@@ -27,6 +27,15 @@ module.exports = defineConfig([
         "dist",
         "ios",
         "android",
+        "_Output",
+        "_Packages",
+        ".cache",
+        ".husky",
+        "**/generated/**/*",
+        "_Zips",
+        "_Pdfs",
+        "_Build/content",
+        "_Build/handlebars/helpers",
     ]),
     {
         plugins: {
@@ -41,6 +50,9 @@ module.exports = defineConfig([
                 ...globals.node,
                 ...globals.es2021,
                 ...globals.mocha,
+                browser: "readonly",
+                fixture: "readonly",
+                expect: "readonly",
             },
         },
         rules: {

package/globals.js

@@ -45,7 +45,7 @@ var exec;
 var running;
 var services;
 var branch;
-var diagnosis = "3.0.0";
+var diagnosis = "4.0.0";
 var opts = { encoding: "utf8", stdio: "inherit", shell: "/bin/bash" };
 const users = {
     core: "node",
@@ -126,8 +126,7 @@ if (composer && composer.require && composer.require["laravel/framework"]) {
             args[0] !== "new" &&
             args[0] !== "key" &&
             args[0] !== "dekey" &&
-            args[0] !== "lint" &&
-            args[0] !== "pretty"
+            args[0] !== "lint"
         ) {
             if (!args.find((d) => d === "--force")) {
                 console.log(
@@ -176,8 +175,7 @@ if (composer && composer.require && composer.require["laravel/framework"]) {
             args[0] !== "new" &&
             args[0] !== "key" &&
             args[0] !== "dekey" &&
-            args[0] !== "lint" &&
-            args[0] !== "pretty"
+            args[0] !== "lint"
         ) {
             if (!args.find((d) => d === "--force")) {
                 console.log(
@@ -238,8 +236,7 @@ if (process.env.FW_NEXT) {
         args[0] !== "new" &&
         args[0] !== "key" &&
         args[0] !== "dekey" &&
-        args[0] !== "lint" &&
-        args[0] !== "pretty"
+        args[0] !== "lint"
     ) {
         if (!args.find((d) => d === "--force")) {
             console.log(
@@ -409,6 +406,13 @@ if (!existsSync(path.join(cwd, "eslint.config.js"))) {
     );
 }
 
+if (!existsSync(path.join(cwd, "stylelint.config.js"))) {
+    copyFileSync(
+        path.join(__dirname, "stylelint.config.js"),
+        path.join(cwd, "stylelint.config.js"),
+    );
+}
+
 // If docker-compose.yml exists in project _Docker folder append to end
 let localOverride = "";
 if (existsSync(path.join(cwd, "_Docker/docker-compose.yml"))) {
@@ -448,6 +452,7 @@ try {
 
 // Always allow commands that don't require a repository through
 if (
+    !process.env.CI_BUILD_ID &&
     args[0] !== "diag" &&
     args[0] !== "diagnose" &&
     args[0] !== "origin" &&
@@ -456,29 +461,30 @@ if (
     args[0] !== "new" &&
     args[0] !== "key" &&
     args[0] !== "dekey" &&
-    args[0] !== "lint" &&
-    args[0] !== "pretty"
+    args[0] !== "lint"
 ) {
-    // Stop here if diagnosis either unset or outdated
-    if (
-        !config.diagnosis ||
-        semver.diff(config.diagnosis, diagnosis) === "major"
-    ) {
-        console.log(
-            `${utilities.colorize(`@fishawack/lab-env`, "title")} diagnosis is ${utilities.colorize(`outdated`, "error")}.\n\nRun ${utilities.colorize(`fw diagnose`, "success")} to reconfigure.`,
-        );
-        process.exit(1);
-        // Warn if diagnosis only minor/patch outdated
-    } else if (semver.diff(config.diagnosis, diagnosis) !== null) {
-        console.log(
-            `${utilities.colorize(`@fishawack/lab-env`, "title")} diagnosis is ${utilities.colorize(`outdated`, "warning")}.\n\nRun ${utilities.colorize(`fw diagnose`, "success")} to reconfigure.`,
-        );
-        // Stop here if docker process not running
-    } else if (!services) {
-        console.log(
-            `${utilities.colorize(`Docker`, "info")} does not appear to be running...\n\nRun ${utilities.colorize(`fw --debug`, "success")} for more information`,
-        );
-        process.exit(1);
+    if (!args.find((d) => d === "--force")) {
+        // Stop here if diagnosis either unset or outdated
+        if (
+            !config.diagnosis ||
+            semver.diff(config.diagnosis, diagnosis) === "major"
+        ) {
+            console.log(
+                `${utilities.colorize(`@fishawack/lab-env`, "title")} diagnosis is ${utilities.colorize(`outdated`, "error")}.\n\nRun ${utilities.colorize(`fw diagnose`, "success")} to reconfigure or pass ${utilities.colorize(`--force`, "warning")} to continue..`,
+            );
+            process.exit(1);
+            // Warn if diagnosis only minor/patch outdated
+        } else if (semver.diff(config.diagnosis, diagnosis) !== null) {
+            console.log(
+                `${utilities.colorize(`@fishawack/lab-env`, "title")} diagnosis is ${utilities.colorize(`outdated`, "warning")}.\n\nRun ${utilities.colorize(`fw diagnose`, "success")} to reconfigure.`,
+            );
+            // Stop here if docker process not running
+        } else if (!services) {
+            console.log(
+                `${utilities.colorize(`Docker`, "info")} does not appear to be running...\n\nRun ${utilities.colorize(`fw --debug`, "success")} for more information or pass ${utilities.colorize(`--force`, "warning")} to continue.`,
+            );
+            process.exit(1);
+        }
     }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@fishawack/lab-env",
-    "version": "4.39.0-beta.7",
+    "version": "4.39.0-beta.8",
     "description": "Docker manager for FW",
     "main": "cli.js",
     "scripts": {

package/stylelint.config.js

@@ -0,0 +1,40 @@
+const globalPath = require("child_process")
+    .execSync("npm root -g")
+    .toString()
+    .trim();
+
+module.exports = {
+    extends: [
+        `${globalPath}/stylelint-config-standard-scss`,
+        `${globalPath}/stylelint-prettier/recommended`,
+    ],
+    rules: {
+        "scss/dollar-variable-pattern": null,
+        "scss/at-mixin-pattern": null,
+        "selector-class-pattern": null,
+        "selector-id-pattern": null,
+        "custom-property-pattern": null,
+    },
+    ignoreFiles: [
+        "**/.git/**/*",
+        "**/.svn/**/*",
+        "**/.hg/**/*",
+        "**/node_modules/**/*",
+        "**/vendor/**/*",
+        "**/storage/**/*",
+        "bootstrap/**/*",
+        "coverage/**/*",
+        ".tmp/**/*",
+        "dist/**/*",
+        "ios/**/*",
+        "android/**/*",
+        "_Output/**/*",
+        "_Packages/**/*",
+        ".cache/**/*",
+        ".husky/**/*",
+        ".**/generated/**/*",
+        "_Zips/**/*",
+        "_Pdfs/**/*",
+        "_Build/content/**/*",
+    ],
+};

package/commands/pretty.js

@@ -1,12 +0,0 @@
-const execSync = require("child_process").execSync;
-
-module.exports = [
-    "pretty",
-    "applies fixes to code style",
-    () => {},
-    () =>
-        execSync("prettier --write .", {
-            encoding: "utf8",
-            stdio: "inherit",
-        }),
-];