@langri-sha/projen-husky 0.1.0

package/CHANGELOG.json

@@ -0,0 +1,20 @@
+{
+  "name": "@langri-sha/projen-husky",
+  "entries": [
+    {
+      "date": "Thu, 09 May 2024 07:29:32 GMT",
+      "version": "0.1.0",
+      "tag": "@langri-sha/projen-husky_v0.1.0",
+      "comments": {
+        "minor": [
+          {
+            "author": "filip.dupanovic@gmail.com",
+            "package": "@langri-sha/projen-husky",
+            "commit": "508fb179ee3454c0e43f7ea2a9ed25ca6310e27b",
+            "comment": "feat(husky): Add support for managing Git hooks"
+          }
+        ]
+      }
+    }
+  ]
+}

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Change Log - @langri-sha/projen-husky
+
+This log was last generated on Thu, 09 May 2024 07:29:32 GMT and should not be manually modified.
+
+<!-- Start content -->
+
+## 0.1.0
+
+Thu, 09 May 2024 07:29:32 GMT
+
+### Minor changes
+
+- feat(husky): Add support for managing Git hooks (filip.dupanovic@gmail.com)

package/lib/index.d.ts

@@ -0,0 +1,16 @@
+import { Component, type Project } from 'projen';
+type Hooks = 'pre-commit' | 'applypatch-msg' | 'pre-applypatch' | 'post-applypatch' | 'pre-commit' | 'pre-merge-commit' | 'prepare-commit-msg' | 'commit-msg' | 'post-commit' | 'pre-rebase' | 'post-checkout' | 'post-merge' | 'pre-push';
+/**
+ * Husky options.
+ */
+export type HuskyOptions = {
+    [hook in Hooks]?: string | string[];
+};
+/**
+ * A component for maintaining Git hooks with Husky.
+ */
+export declare class Husky extends Component {
+    constructor(project: Project, options?: HuskyOptions);
+}
+export {};
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,KAAK,OAAO,EAAY,MAAM,QAAQ,CAAA;AAE1D,KAAK,KAAK,GACN,YAAY,GACZ,gBAAgB,GAChB,gBAAgB,GAChB,iBAAiB,GACjB,YAAY,GACZ,kBAAkB,GAClB,oBAAoB,GACpB,YAAY,GACZ,aAAa,GACb,YAAY,GACZ,eAAe,GACf,YAAY,GACZ,UAAU,CAAA;AAEd;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;KACxB,IAAI,IAAI,KAAK,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE;CACpC,CAAA;AAED;;GAEG;AACH,qBAAa,KAAM,SAAQ,SAAS;gBACtB,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,YAAY;CAwBrD"}

package/lib/index.js

@@ -0,0 +1,25 @@
+import path from 'node:path';
+import { Component, TextFile } from 'projen';
+/**
+ * A component for maintaining Git hooks with Husky.
+ */
+export class Husky extends Component {
+    constructor(project, options) {
+        super(project);
+        for (const [hook, commands] of Object.entries(options ?? {}).map(([hook, commands]) => [hook, Array.isArray(commands) ? commands : [commands]])) {
+            const file = new TextFile(project, path.join('.husky', hook), {
+                editGitignore: false,
+                marker: true,
+                readonly: true,
+            });
+            if (!project.ejected) {
+                file.addLine(`# ${file.marker}`);
+            }
+            for (const command of commands) {
+                file.addLine(command);
+            }
+            file.addLine('');
+        }
+    }
+}
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,WAAW,CAAA;AAC5B,OAAO,EAAE,SAAS,EAAgB,QAAQ,EAAE,MAAM,QAAQ,CAAA;AAwB1D;;GAEG;AACH,MAAM,OAAO,KAAM,SAAQ,SAAS;IAClC,YAAY,OAAgB,EAAE,OAAsB;QAClD,KAAK,CAAC,OAAO,CAAC,CAAA;QAEd,KAAK,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,GAAG,CAC9D,CAAC,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,CACnB,CAAC,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAU,CACnE,EAAE,CAAC;YACF,MAAM,IAAI,GAAG,IAAI,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,EAAE;gBAC5D,aAAa,EAAE,KAAK;gBACpB,MAAM,EAAE,IAAI;gBACZ,QAAQ,EAAE,IAAI;aACf,CAAC,CAAA;YAEF,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;gBACrB,IAAI,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC,MAAM,EAAE,CAAC,CAAA;YAClC,CAAC;YAED,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;gBAC/B,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;YACvB,CAAC;YAED,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;QAClB,CAAC;IACH,CAAC;CACF"}

package/license

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2024 Filip Dupanović <filip.dupanovic@gmail.com> (https://langri-sha.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@langri-sha/projen-husky",
+  "version": "0.1.0",
+  "license": "MIT",
+  "type": "module",
+  "main": "lib/index.js",
+  "scripts": {
+    "prepublishOnly": "rm -rf lib; tsc --project tsconfig.build.json"
+  },
+  "devDependencies": {
+    "@langri-sha/jest-test": "0.7.1",
+    "@langri-sha/tsconfig": "0.9.0",
+    "@types/node": "20.12.7",
+    "projen": "0.81.1"
+  },
+  "peerDependencies": {
+    "husky": "^9.0.0",
+    "projen": "^0.81.1",
+    "typescript": "^5.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "types": "lib/index.d.ts"
+}

package/readme

@@ -0,0 +1,29 @@
+# @langri-sha/projen-codeowners
+
+A [projen] component for managing [CODEOWNERS].
+
+## Usage
+
+```sh
+npm install -D projen @langri-sha/projen-codeowners`.
+```
+
+Then, create the `Codeowners` component for your root project:
+
+```js
+import { Project } from 'projen'
+import { Codeowners } from '@langri-sha/projen-codeowners`
+
+const project = new Project({
+  name: 'my-project',
+})
+
+new Codeowners(project, {
+  '*': '@admins',
+  '*.js': ['@developers', '@frontend']
+}
+```
+
+[projen]: https://projen.io/
+[codeowners]:
+  https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners

package/src/index.ts

@@ -0,0 +1,54 @@
+import path from 'node:path'
+import { Component, type Project, TextFile } from 'projen'
+
+type Hooks =
+  | 'pre-commit'
+  | 'applypatch-msg'
+  | 'pre-applypatch'
+  | 'post-applypatch'
+  | 'pre-commit'
+  | 'pre-merge-commit'
+  | 'prepare-commit-msg'
+  | 'commit-msg'
+  | 'post-commit'
+  | 'pre-rebase'
+  | 'post-checkout'
+  | 'post-merge'
+  | 'pre-push'
+
+/**
+ * Husky options.
+ */
+export type HuskyOptions = {
+  [hook in Hooks]?: string | string[]
+}
+
+/**
+ * A component for maintaining Git hooks with Husky.
+ */
+export class Husky extends Component {
+  constructor(project: Project, options?: HuskyOptions) {
+    super(project)
+
+    for (const [hook, commands] of Object.entries(options ?? {}).map(
+      ([hook, commands]) =>
+        [hook, Array.isArray(commands) ? commands : [commands]] as const,
+    )) {
+      const file = new TextFile(project, path.join('.husky', hook), {
+        editGitignore: false,
+        marker: true,
+        readonly: true,
+      })
+
+      if (!project.ejected) {
+        file.addLine(`# ${file.marker}`)
+      }
+
+      for (const command of commands) {
+        file.addLine(command)
+      }
+
+      file.addLine('')
+    }
+  }
+}