@fishawack/lab-env 4.39.0-beta.6 → 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,42 @@
 ## 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
+
+* added eslint configuration and global deps ([2edd07a](https://bitbucket.org/fishawackdigital/lab-env/commits/2edd07a602c601dcb1ff7e668f002a1f5ec675e3))
+* added positional flag to lint command ([a9d1090](https://bitbucket.org/fishawackdigital/lab-env/commits/a9d109079721765a462c7fbfefecd4ae7177a4dd))
+* copy eslint.config.js to project repo ([900f2e7](https://bitbucket.org/fishawackdigital/lab-env/commits/900f2e765322633a1f6e82bc4389c2ea2e8ff635))
+* show the installing npm module in guide ([d5b4113](https://bitbucket.org/fishawackdigital/lab-env/commits/d5b41136c15f7e5ce74e05240742b817fb999474))
+
+#### Bug Fixes
+
+* remove airbnb dep as not needed ([494b6af](https://bitbucket.org/fishawackdigital/lab-env/commits/494b6afd2a635a0e817599cf5ae8ef1f0315d746))
+* use global prettier instead of npx ([912e598](https://bitbucket.org/fishawackdigital/lab-env/commits/912e598703705586a5aeb923100b82ea19335a4f))
+* use var as let not supported in cloudfront functions v5 ([6656ff3](https://bitbucket.org/fishawackdigital/lab-env/commits/6656ff319e812273c20b9b14425a90be194c4035))
+
 ### 4.39.0-beta.6 (2025-05-15)
 
 #### 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,15 +9,24 @@ describe("provision", () => {
     let config;
     let repo = "lab-env-test-suite";
     let account = "fishawack";
+    let branch = "development";
+    let name = aws.slug(repo, account, branch);
 
     describe("static", () => {
         before(async () => {
             fetch = (await import("node-fetch")).default;
 
-            config = await aws.static(repo, account);
+            config = await aws.static(
+                name,
+                account,
+                undefined,
+                undefined,
+                repo,
+                branch,
+            );
 
             await aws.s3.addFileToS3Bucket(
-                repo,
+                name,
                 account,
                 "index.html",
                 new TextEncoder().encode("test"),
@@ -29,13 +38,13 @@ describe("provision", () => {
         });
 
         after(async () => {
-            await aws.s3.removeFileToS3Bucket(repo, account, "index.html");
+            await aws.s3.removeFileToS3Bucket(name, account, "index.html");
 
             await aws.staticTerminate(
-                repo,
+                name,
                 account,
                 repo,
-                "development",
+                branch,
                 config.cloudfront,
             );
         });
@@ -53,7 +62,7 @@ describe("provision", () => {
                 [],
                 [],
                 repo,
-                "development",
+                branch,
                 "wordpress",
             );
         });
@@ -65,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/_Test/s3.js

@@ -38,7 +38,9 @@ describe("s3", () => {
                 await s3.removeFileToS3Bucket(repo, account, "index.html");
 
                 await s3.removeS3Bucket(repo, account);
-            } catch (e) {}
+            } catch {
+                /* empty */
+            }
         });
     });
 });

package/_Test/utilities.js

@@ -22,6 +22,7 @@ describe("utilities", async () => {
         });
 
         it("Should convert _ to -", async () => {
+            // eslint-disable-next-line no-useless-escape
             expect(s3Safe("___").match(/\_/g)).to.be.null;
         });
 
@@ -40,6 +41,7 @@ describe("utilities", async () => {
         it("Should remove any special chars", async () => {
             expect(
                 s3Safe("!@#$%^&*()=_+;,./<>?~`|").match(
+                    // eslint-disable-next-line no-useless-escape
                     /[\!\@\#\$\%\^\&\*\(\)\=\_\+\;\,\.\/\<\>\?\~\`\|]/g,
                 ),
             ).to.be.null;
@@ -64,6 +66,7 @@ describe("utilities", async () => {
         });
 
         it("Should convert _ to -", async () => {
+            // eslint-disable-next-line no-useless-escape
             expect(ebSafe("___").match(/\_/g)).to.be.null;
         });
 
@@ -82,6 +85,7 @@ describe("utilities", async () => {
         it("Should remove any special chars", async () => {
             expect(
                 ebSafe("!@#$%^&*()=_+;,./<>?~`|").match(
+                    // eslint-disable-next-line no-useless-escape
                     /[\!\@\#\$\%\^\&\*\(\)\=\_\+\;\,\.\/\<\>\?\~\`\|]/g,
                 ),
             ).to.be.null;

package/cli.js

@@ -58,7 +58,6 @@ const args = hideBin(process.argv);
             "connect",
             "execute",
             "lint",
-            "pretty",
         );
 
         if (_.config.preset === "permanent") {
@@ -144,9 +143,8 @@ const args = hideBin(process.argv);
 // Remove network leftover by docker-compose run
 function shutdown() {
     try {
-        execSync(
-            `docker network rm ${_.repo_safe}_default &>/dev/null`,
-            _.opts,
-        );
-    } catch (e) {}
+        execSync(`docker network rm ${_.repoSafe}_default &>/dev/null`, _.opts);
+    } catch {
+        /* empty */
+    }
 }

package/commands/check.js

@@ -25,6 +25,7 @@ module.exports = [
         ) {
             _.command(
                 "php",
+                // eslint-disable-next-line no-useless-escape
                 `${argv.v ? `composer install --dry-run 2>&1 | grep '\\- Installing' | while read -r line; do echo \\$\{line/'Installing'\}; done && ` : ""}composer install --dry-run 2>&1 | grep -q 'Nothing to install, update or remove' && echo -e '\\033[0;32mComposer deps OK\\033[0m' || echo -e '\\033[0;31mComposer deps missing or outdated\\033[0m'`,
             );
         }

package/commands/clean.js

@@ -3,8 +3,8 @@ const _ = require("../globals.js");
 module.exports = [
     "clean",
     "cleans out dependencies",
-    (yargs) => {},
-    (argv) => {
+    () => {},
+    () => {
         _.command("core", `git clean -xfd node_modules/ 2>/dev/null || true`);
 
         if (

package/commands/content.js

@@ -17,8 +17,8 @@ module.exports = [
             const stringify = JSON.stringify(
                 {
                     "aws-s3": "fishawack",
-                    location: `fw-auto-content/${_.repo_safe}`,
-                    key: `fw-s3-${_.repo_safe}`,
+                    location: `fw-auto-content/${_.repoSafe}`,
+                    key: `fw-s3-${_.repoSafe}`,
                     sync: true,
                 },
                 null,

package/commands/create/cmds/dekey.js

@@ -1,13 +1,12 @@
 const _ = require("../../../globals.js");
-const utilities = require("../libs/utilities");
 const inquirer = require("inquirer");
 const aws = require("../services/aws/index.js");
 
 module.exports = [
     "dekey",
     false,
-    (yargs) => {},
-    async (argv) => {
+    () => {},
+    async () => {
         let users = [];
         let clients = [];
 

package/commands/create/cmds/deprovision.js

@@ -48,7 +48,7 @@ module.exports = [
         }
 
         const slug = aws.slug(
-            _.repo_safe,
+            _.repoSafe,
             answers.client,
             branch,
             answers.stack === "static" ? "s3" : "eb",
@@ -70,7 +70,7 @@ module.exports = [
         await aws[`${answers.stack}Terminate`](
             slug,
             answers.client,
-            _.repo_safe,
+            _.repoSafe,
             branch,
             answers.id,
         );

package/commands/create/cmds/diagnose.js

@@ -42,6 +42,7 @@ module.exports = [
             let preset = await guide.preset(argv);
 
             if (argv.l == null && preset === "permanent") {
+                // eslint-disable-next-line no-param-reassign
                 argv.legacy = argv.l = true;
             }
 
@@ -73,8 +74,8 @@ module.exports = [
                 await guide.strict(argv);
             }
 
-            while (!(await test.global_modules())) {
-                await guide.global_modules(argv);
+            while (!(await test.globalModules())) {
+                await guide.globalModules(argv);
             }
 
             if (preset === "permanent" || preset === "freelancer") {

package/commands/create/cmds/key.js

@@ -11,8 +11,8 @@ const htmlEmail = require("fs").readFileSync(
 module.exports = [
     "key",
     false,
-    (yargs) => {},
-    async (argv) => {
+    () => {},
+    async () => {
         let users = [];
         let clients = [];
         let sendEmail = false;

package/commands/create/cmds/provision.js

@@ -84,7 +84,7 @@ module.exports = [
                         type: "input",
                         name: "username",
                         message: "Username",
-                        default: `${_.repo_safe}User${credentials.length ? `-${credentials.length}` : ""}`,
+                        default: `${_.repoSafe}User${credentials.length ? `-${credentials.length}` : ""}`,
                         validate: (input) => !!input.length,
                     },
                     {
@@ -115,7 +115,7 @@ module.exports = [
         let config = {};
         let infastructure;
         const slug = aws.slug(
-            _.repo_safe,
+            _.repoSafe,
             answers.client,
             branch,
             answers.stack === "static" ? "s3" : "eb",
@@ -131,7 +131,7 @@ module.exports = [
                     { Key: "automated", Value: true },
                 ],
                 credentials,
-                _.repo_safe,
+                _.repoSafe,
                 branch,
                 answers.framework,
                 answers.availability,

package/commands/create/libs/aws-cloudfront-auth.js

@@ -1,15 +1,18 @@
+// eslint-disable-next-line no-unused-vars
 function handler(event) {
+    var query, index, key, response;
+
     // Redirect if www to non-www
     if (event.request.headers.host.value.includes("www.")) {
-        var query = "";
-        var index = 0;
+        query = "";
+        index = 0;
 
-        for (var key in event.request.querystring) {
+        for (key in event.request.querystring) {
             query += `${index ? "&" : "?"}${key}=${event.request.querystring[key].value}`;
             index++;
         }
 
-        var response = {
+        response = {
             statusCode: 301,
             statusDescription: "Moved Permanently",
             headers: {
@@ -27,10 +30,10 @@ function handler(event) {
 
     // Redirect if no trailing slash
     if (!event.request.uri.includes(".") && !event.request.uri.endsWith("/")) {
-        var query = "";
-        var index = 0;
+        query = "";
+        index = 0;
 
-        for (var key in event.request.querystring) {
+        for (key in event.request.querystring) {
             query += `${index ? "&" : "?"}${key}=${event.request.querystring[key].value}`;
             index++;
         }
@@ -70,7 +73,7 @@ function handler(event) {
     // But if we get here, we must either be missing the auth header or the
     // credentials failed to match what we expected.
     // Request the browser present the Basic Auth dialog.
-    var response = {
+    response = {
         statusCode: 401,
         statusDescription: "Unauthorized",
         headers: {

package/commands/create/libs/aws-cloudfront-response.js

@@ -1,3 +1,4 @@
+// eslint-disable-next-line no-unused-vars
 function handler(event) {
     // Add security headers
     var response = event.response;

package/commands/create/libs/aws-cloudfront-simple.js

@@ -1,15 +1,18 @@
+// eslint-disable-next-line no-unused-vars
 function handler(event) {
+    var query, index, key, response;
+
     // Redirect if www to non-www
     if (event.request.headers.host.value.includes("www.")) {
-        var query = "";
-        var index = 0;
+        query = "";
+        index = 0;
 
-        for (var key in event.request.querystring) {
+        for (key in event.request.querystring) {
             query += `${index ? "&" : "?"}${key}=${event.request.querystring[key].value}`;
             index++;
         }
 
-        var response = {
+        response = {
             statusCode: 301,
             statusDescription: "Moved Permanently",
             headers: {
@@ -27,10 +30,10 @@ function handler(event) {
 
     // Redirect if no trailing slash
     if (!event.request.uri.includes(".") && !event.request.uri.endsWith("/")) {
-        var query = "";
-        var index = 0;
+        query = "";
+        index = 0;
 
-        for (var key in event.request.querystring) {
+        for (key in event.request.querystring) {
             query += `${index ? "&" : "?"}${key}=${event.request.querystring[key].value}`;
             index++;
         }

package/commands/create/libs/utilities.js

@@ -47,6 +47,7 @@ module.exports.Spinner = class Spinner {
     }
 
     action(message, action, success, failure) {
+        // eslint-disable-next-line no-async-promise-executor
         return new Promise(async (resolve, reject) => {
             let instance = new this.constructor(message);
             let res;
@@ -65,6 +66,7 @@ module.exports.Spinner = class Spinner {
     }
 
     simple(message, action) {
+        // eslint-disable-next-line no-async-promise-executor
         return new Promise(async (resolve, reject) => {
             let instance = new this.constructor(message, true);
             let res;
@@ -127,6 +129,7 @@ module.exports.nameSafe = (name, service = "s3") => {
     safe = `${prefix}${safe}`;
     safe = `${safe}${suffix}`;
     safe = safe.replace(/\./g, "-");
+    // eslint-disable-next-line no-useless-escape
     safe = safe.replace(/\_/g, "-");
 
     return safe;

package/commands/create/libs/vars.js

@@ -11,7 +11,7 @@ try {
     miscFile = JSON.parse(
         fs.readFileSync(path.join(os.homedir(), "targets", "misc.json")),
     );
-} catch (e) {
+} catch {
     miscFile = {
         bitbucket: {},
         gitlab: {},
@@ -29,7 +29,7 @@ try {
             encoding: "utf8",
         }),
     );
-} catch (e) {
+} catch {
     ftppassFile = {};
 }
 
@@ -45,7 +45,7 @@ try {
             { encoding: "utf8" },
         ),
     );
-} catch (e) {
+} catch {
     creds.egnyte = {};
 }
 
@@ -71,27 +71,27 @@ module.exports.headers = {
 };
 
 // Required global node modules
-module.exports.global_modules = [
-    {
-        package: "@commitlint/cli",
-        version: "19",
-    },
-    {
-        package: "@commitlint/config-conventional",
-        version: "19",
-    },
-    {
-        package: "husky",
-        version: "9",
-    },
-    {
-        package: "prettier",
-        version: "3",
-    },
-    {
-        package: "@prettier/plugin-php",
-        version: "0",
-    },
+module.exports.globalModules = [
+    // HUSKY
+    { package: "husky", version: "9" },
+    // COMMITLINT
+    { package: "@commitlint/cli", version: "19" },
+    { package: "@commitlint/config-conventional", version: "19" },
+    // PRETTIER
+    { package: "prettier", version: "3" },
+    { package: "@prettier/plugin-php", version: "0" },
+    // ESLINT
+    { 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/create/services/aws/cloudfront.js

@@ -212,7 +212,7 @@ module.exports.createCloudFrontFunction = async (name, account, fn, config) => {
                 );
             },
         );
-    } catch (e) {
+    } catch {
         res = await Spinner.prototype.simple(
             `Retrieving the already existing CloudFront function`,
             () => {

package/commands/create/services/aws/iam.js

@@ -36,7 +36,7 @@ module.exports.createIAMUser = async (UserName, account, tags = []) => {
                 );
             },
         );
-    } catch (e) {
+    } catch {
         res = await Spinner.prototype.simple(
             `Retrieving the already existing IAM user ${UserName}`,
             () => {
@@ -81,7 +81,9 @@ module.exports.removeIAMUser = async (UserName, account) => {
                 return client.send(new DeleteUserCommand({ UserName }));
             },
         );
-    } catch (e) {}
+    } catch {
+        /* empty */
+    }
 
     return res;
 };
@@ -347,7 +349,7 @@ module.exports.ensureEBInstanceProfileExists = async (account) => {
 
     try {
         await module.exports.getRole(role, account);
-    } catch (e) {
+    } catch {
         await module.exports.createRole(
             role,
             account,