chore: lint-staged (#3401)

This adds `lint-staged` to all packages and the root to lint staged changes depending on the package (environment). 1. root: lint lock-file only 2. kuma-gui: lint styles and scripts only 3. config: lint scripts only --- Apart from lint-staged all the shareable make targets and recipes have been moved to our config/tooling package. --------- Signed-off-by: schogges <[email protected]>
kumahq · Jan 15, 2025 · 20ae344 · 20ae344
1 parent 6553bbb
commit 20ae344
Show file tree

Hide file tree

Showing 13 changed files with 23 additions and 10 deletions.
diff --git a/.lintstagedrc.json b/.lintstagedrc.json
@@ -0,0 +1,3 @@
+{
+  "package-lock.json": "make lint/lock"
+}
diff --git a/Makefile b/Makefile
@@ -1,11 +1,18 @@
 SHELL := /usr/bin/env bash
-MK := ./packages/kuma-gui/mk
+MK := ./packages/config/src/mk
+
+## make help: if you're aren't sure use `make help`
+.DEFAULT_GOAL := help
 
 include $(MK)/install.mk
 include $(MK)/check.mk
+include $(MK)/help.mk
 
 .PHONY: clean
 clean: .clean ## Dev: Remove all `node_modules` recursively
 
 .PHONY: install
 install: .install ## Dev: Install all dependencies
+
+.PHONY: help
+help: .help ## Display this help screen
diff --git a/packages/config/.lintstagedrc.json b/packages/config/.lintstagedrc.json
@@ -1,3 +1,3 @@
 {
-  "*.{cjs,js,ts}": "make lint"
+  "*.{cjs,js,ts,vue}": "make lint"
 }
diff --git a/packages/config/Makefile b/packages/config/Makefile
@@ -1,6 +1,13 @@
-MK := ../kuma-gui/mk
+MK := ./src/mk
+
+## make help: if you're aren't sure use `make help`
+.DEFAULT_GOAL := help
 
 include $(MK)/check.mk
+include $(MK)/help.mk
+
+.PHONY: help
+help: .help ## Display this help screen
 
 .PHONY: lint
 lint: .lint/script ## Dev: Run all lint script checks (js,ts)
diff --git a/packages/kuma-gui/mk/build.mk → packages/config/src/mk/build.mk b/packages/kuma-gui/mk/build.mk → packages/config/src/mk/build.mk
diff --git a/packages/kuma-gui/mk/check.mk → packages/config/src/mk/check.mk b/packages/kuma-gui/mk/check.mk → packages/config/src/mk/check.mk
diff --git a/packages/kuma-gui/mk/help.mk → packages/config/src/mk/help.mk b/packages/kuma-gui/mk/help.mk → packages/config/src/mk/help.mk
diff --git a/packages/kuma-gui/mk/install.mk → packages/config/src/mk/install.mk b/packages/kuma-gui/mk/install.mk → packages/config/src/mk/install.mk
diff --git a/packages/kuma-gui/mk/release.mk → packages/config/src/mk/release.mk b/packages/kuma-gui/mk/release.mk → packages/config/src/mk/release.mk
diff --git a/packages/kuma-gui/mk/run.mk → packages/config/src/mk/run.mk b/packages/kuma-gui/mk/run.mk → packages/config/src/mk/run.mk
diff --git a/packages/kuma-gui/mk/test.mk → packages/config/src/mk/test.mk b/packages/kuma-gui/mk/test.mk → packages/config/src/mk/test.mk
diff --git a/packages/kuma-gui/.lintstagedrc.json b/packages/kuma-gui/.lintstagedrc.json
@@ -1,5 +1,4 @@
 {
-  "*.{js,ts,vue}": "make -C ./packages/kuma-gui -j2 lint/script",
-  "*.{css,scss,vue}": "make -C ./packages/kuma-gui lint/css",
-  "package-lock.json": "make -C ./packages/kuma-gui lint/lock"
+  "*.{cjs,js,ts,vue}": "make -j2 .lint/script",
+  "*.{css,scss,vue}": "make lint/css"
 }
diff --git a/packages/kuma-gui/Makefile b/packages/kuma-gui/Makefile
@@ -2,7 +2,7 @@
 # It should only be used for adding "non-dot" aliases and documentation
 
 SHELL := /usr/bin/env bash
-MK := ./mk
+MK := ../config/src/mk
 NODE_VERSION:=v$(shell cat ../../.nvmrc)
 NPM_WORKFLOW_CONFIG_PATH ?= $(shell readlink -f ../config)
 
@@ -28,9 +28,6 @@ install/sync: .install/sync
 .PHONY: help
 help: .help ## Display this help screen
 
-.PHONY: clean
-clean: .clean ## Dev: Delete all node_modules directories
-
 .PHONY: install
 install: .install ## Dev: install all dependencies (runs before `make run`)