@meistrari/mise-en-place 2.8.0 → 2.10.0

package/Makefile

@@ -2,6 +2,7 @@
 default: help
 
 _MISE_EN_PLACE_PACKAGE_NAME = @meistrari/mise-en-place
+MISE_EN_PLACE_INSTALL_DIR ?= .
 
 # region Public commands
 
@@ -21,7 +22,7 @@ mise-en-place: .editorconfig ## Setup the mise en place to start cooking
 .PHONY: help
 help:
 	@echo "Make tasks:"
-	@grep -hE '^[%a-zA-Z_-]+:.*?## .*$$' Makefile ./node_modules/$(_MISE_EN_PLACE_PACKAGE_NAME)/Makefile | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m  %-17s\033[0m %s\n", $$1, $$2}'
+	@grep -hE '^[%a-zA-Z_-]+:.*?## .*$$' Makefile $(MISE_EN_PLACE_INSTALL_DIR)/node_modules/$(_MISE_EN_PLACE_PACKAGE_NAME)/Makefile | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m  %-17s\033[0m %s\n", $$1, $$2}'
 	@echo ""
 
 # endregion

package/README.md

@@ -15,30 +15,33 @@ Add `mise-en-place postinstall` to your project's `package.json` `postinstall` s
 }
 ```
 
-Then install the package as a development dependency:
+Then install the package as a development dependency and run the postinstall script:
 ```sh
-npm i -D @meistrari/mise-en-place
+bun i -D @meistrari/mise-en-place
+bunx mise-en-place postinstall
 ```
 
-After installing, it will create a `Makefile` in your project if one does not already exist.
-If you already have a `Makefile`, you can manually include this project's Makefile by adding the following line to your existing `Makefile`:
-```makefile
-include ./node_modules/@meistrari/mise-en-place/Makefile
-```
-
-It will also setup the initial _mise-en-place_ in your project.
+It will also setup the initial _mise-en-place_ in your project. Which includes:
+- Adding a `Makefile` with useful commands.
+- Adding an `.editorconfig` file.
+- Adding ESLint configuration.
+- Adding TypeScript configuration.
+- Setting up `postinstall` script to keep all `@meistrari/*` packages up to date.
 
 # Features
 
 ## Keep all @meistrari/* packages up to date
-By adding the `postinstall` script, every time you run `npm install`, it will check for the latest versions of all `@meistrari/*` packages in your project and update them if necessary.
+By adding the `postinstall` script to run `mise-en-place postinstall`, every time you run install your dependencies, it will check for the latest versions of all `@meistrari/*` packages in your project and update them if necessary.
+
+This process will add a leading caret (`^`) to the version range if it is not already present. Which means that it will update to the latest minor and patch versions automatically but never the major version.
 
 ## Makefile
 Commands with `##` after the target are 'public' commands and are intended to be used by developers and will show up in the help message.
+
 The other commands are 'hidden' and are intended to be used by automations or by other 'public' commands.
 
 ## EditorConfig
-Run `make .editorconfig` to copy this project's `.editorconfig` to your project.
+Since the editorconfig file [don't support extending from other files](https://github.com/editorconfig/editorconfig/issues/236), the postinstall script will always copy the `.editorconfig` file from this project to your project root.
 
 ## Eslint Config
 Add the following code in your `eslint.config.mjs` to include this project's ESLint configuration:
@@ -47,6 +50,23 @@ Add the following code in your `eslint.config.mjs` to include this project's ESL
 export { default } from '@meistrari/mise-en-place/eslint'
 ```
 
+> If some rules needs to be updated, you can update the rules in this project (preferrable) or customize them in your own configuration (not preferrable).
+> You probably don't need to customize the configuration, since it is already designed to be a good starting point for most projects.
+> Remember that customizing too much can make your project diverge from the standard and make it harder to maintain.
+
+If you understand the risk and NEED to customize the configuration, you can import the default configuration and extend it:
+
+```ts
+import miseEnPlaceEslintConfig from '@meistrari/mise-en-place/eslint'
+
+export default miseEnPlaceEslintConfig
+    .append({
+        rules: {
+            // your custom rules here
+        }
+    })
+```
+
 ## TSConfig
 
 Add the following code in your `tsconfig.json` to include this project's TypeScript configuration:

package/dist/cli/cli.mjs

@@ -5,7 +5,6 @@ import { globSync } from 'glob';
 import { execSync } from 'node:child_process';
 import { dirname } from 'node:path';
 import { parse } from 'yaml';
-import dedent from 'dedent';
 
 function readPackageJson(path) {
   return JSON.parse(readFileSync(path, "utf-8"));
@@ -241,15 +240,14 @@ function handleMakefileInitialSetup() {
 ${makefileContent}`;
   writeFileSync("Makefile", newContent);
 }
-const miseEnPlaceExtends = "./node_modules/@meistrari/mise-en-place/tsconfig.base.json";
+const miseEnPlaceTsConfigExtends = "./node_modules/@meistrari/mise-en-place/tsconfig.base.json";
 function handleTsConfig() {
   if (!existsSync("tsconfig.json")) {
     console.log("No tsconfig.json found. Generating one that extends mise-en-place tsconfig.json.");
     writeFileSync(
       "tsconfig.json",
-      dedent`{
-                "extends": "${miseEnPlaceExtends}"
-            }`
+      `{ "extends": "${miseEnPlaceTsConfigExtends}" }
+`
     );
     return;
   }
@@ -257,27 +255,27 @@ function handleTsConfig() {
   const tsconfigContent = JSON.parse(tsconfigRaw);
   if (!tsconfigContent.extends) {
     console.log("tsconfig.json has no extends field. Adding mise-en-place tsconfig as extends.");
-    tsconfigContent.extends = miseEnPlaceExtends;
+    tsconfigContent.extends = miseEnPlaceTsConfigExtends;
     writeFileSync("tsconfig.json", `${JSON.stringify(tsconfigContent, null, 4)}
 `);
     return;
   }
   if (typeof tsconfigContent.extends === "string") {
-    if (tsconfigContent.extends === miseEnPlaceExtends) {
+    if (tsconfigContent.extends === miseEnPlaceTsConfigExtends) {
       return;
     }
     console.log("tsconfig.json extends is a string. Converting to array and adding mise-en-place tsconfig.");
-    tsconfigContent.extends = [tsconfigContent.extends, miseEnPlaceExtends];
+    tsconfigContent.extends = [tsconfigContent.extends, miseEnPlaceTsConfigExtends];
     writeFileSync("tsconfig.json", `${JSON.stringify(tsconfigContent, null, 4)}
 `);
     return;
   }
   if (Array.isArray(tsconfigContent.extends)) {
-    if (tsconfigContent.extends.includes(miseEnPlaceExtends)) {
+    if (tsconfigContent.extends.includes(miseEnPlaceTsConfigExtends)) {
       return;
     }
     console.log("tsconfig.json extends is an array. Adding mise-en-place tsconfig to the extends array.");
-    tsconfigContent.extends.push(miseEnPlaceExtends);
+    tsconfigContent.extends.push(miseEnPlaceTsConfigExtends);
     writeFileSync("tsconfig.json", `${JSON.stringify(tsconfigContent, null, 4)}
 `);
     return;
@@ -294,11 +292,33 @@ function handleEditorconfigFile() {
   const editorconfigContent = readFileSync(`./node_modules/${packageName}/.editorconfig`, "utf-8");
   writeFileSync(".editorconfig", editorconfigContent);
 }
+function handlePackageJsonScripts() {
+  if (!existsSync("package.json")) {
+    throw new Error("No package.json found. Skipping package.json scripts setup.");
+  }
+  const packageJsonRaw = readFileSync("package.json", "utf-8");
+  const packageJsonContent = JSON.parse(packageJsonRaw);
+  if (!packageJsonContent.scripts) {
+    packageJsonContent.scripts = {};
+  }
+  const {
+    postinstall: currentPostinstallScript
+  } = packageJsonContent.scripts;
+  const miseEnPlacePostinstallScript = "mise-en-place postinstall";
+  if (currentPostinstallScript?.includes(miseEnPlacePostinstallScript)) {
+    return;
+  }
+  const newPostinstallScript = currentPostinstallScript ? `${miseEnPlacePostinstallScript} && ${currentPostinstallScript}` : miseEnPlacePostinstallScript;
+  packageJsonContent.scripts.postinstall = newPostinstallScript;
+  writeFileSync("package.json", `${JSON.stringify(packageJsonContent, null, 4)}
+`);
+}
 function postinstall(args) {
   handleMakefileInitialSetup();
   handleTsConfig();
   handleEslintConfigFile();
   handleEditorconfigFile();
+  handlePackageJsonScripts();
   updateMeistrariLibraries(args);
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@meistrari/mise-en-place",
-  "version": "2.8.0",
+  "version": "2.10.0",
   "description": "",
   "repository": {
     "type": "git",