@langri-sha/projen-license 0.1.0

package/CHANGELOG.json

@@ -0,0 +1,38 @@
+{
+  "name": "@langri-sha/projen-license",
+  "entries": [
+    {
+      "date": "Sat, 25 May 2024 03:25:02 GMT",
+      "version": "0.1.0",
+      "tag": "@langri-sha/projen-license_v0.1.0",
+      "comments": {
+        "minor": [
+          {
+            "author": "filip.dupanovic@gmail.com",
+            "package": "@langri-sha/projen-license",
+            "commit": "1b0960cb6ed3918c64dbc464cb2baa83f5dc9bdd",
+            "comment": "feat(license): Update documentation"
+          },
+          {
+            "author": "filip.dupanovic@gmail.com",
+            "package": "@langri-sha/projen-license",
+            "commit": "1b0960cb6ed3918c64dbc464cb2baa83f5dc9bdd",
+            "comment": "feat(projen): Add NPM ignore files"
+          },
+          {
+            "author": "filip.dupanovic@gmail.com",
+            "package": "@langri-sha/projen-license",
+            "commit": "1b0960cb6ed3918c64dbc464cb2baa83f5dc9bdd",
+            "comment": "feat(license): Add component for generating licenses"
+          },
+          {
+            "author": "filip.dupanovic@gmail.com",
+            "package": "@langri-sha/projen-license",
+            "commit": "1b0960cb6ed3918c64dbc464cb2baa83f5dc9bdd",
+            "comment": "feat(project): Add projenrc file to subprojects"
+          }
+        ]
+      }
+    }
+  ]
+}

package/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Change Log - @langri-sha/projen-license
+
+This log was last generated on Sat, 25 May 2024 03:25:02 GMT and should not be manually modified.
+
+<!-- Start content -->
+
+## 0.1.0
+
+Sat, 25 May 2024 03:25:02 GMT
+
+### Minor changes
+
+- feat(license): Update documentation (filip.dupanovic@gmail.com)
+- feat(projen): Add NPM ignore files (filip.dupanovic@gmail.com)
+- feat(license): Add component for generating licenses (filip.dupanovic@gmail.com)
+- feat(project): Add projenrc file to subprojects (filip.dupanovic@gmail.com)

package/lib/index.d.ts

@@ -0,0 +1,29 @@
+/// <reference types="src/license" />
+import { FileBase, type IResolver, Project } from 'projen';
+import { type Spdx } from 'license-o-matic';
+export interface LicenseOptions {
+    /**
+     * Name of tile license file.
+     *
+     * @default "license"
+     */
+    readonly filename?: string;
+    /**
+     * License identifier.
+     */
+    readonly spdx: Spdx | string;
+    /**
+     * Copyright year.
+     */
+    readonly year: string;
+    /**
+     * Copyright holder.
+     */
+    readonly copyrightHolder: string;
+}
+export declare class License extends FileBase {
+    #private;
+    constructor(project: Project, { copyrightHolder, filename, spdx, year }: LicenseOptions);
+    protected synthesizeContent(_: IResolver): string | undefined;
+}
+//# 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":";AAAA,OAAO,EAAE,QAAQ,EAAE,KAAK,SAAS,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAA;AAC1D,OAAsB,EAAE,KAAK,IAAI,EAAE,MAAM,iBAAiB,CAAA;AAE1D,MAAM,WAAW,cAAc;IAC7B;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;IAE1B;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAAA;IAE5B;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAA;CACjC;AAED,qBAAa,OAAQ,SAAQ,QAAQ;;gBAIjC,OAAO,EAAE,OAAO,EAChB,EAAE,eAAe,EAAE,QAAoB,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,cAAc;IAavE,SAAS,CAAC,iBAAiB,CAAC,CAAC,EAAE,SAAS,GAAG,MAAM,GAAG,SAAS;CAG9D"}

package/lib/index.js

@@ -0,0 +1,32 @@
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _License_text;
+import { FileBase } from 'projen';
+import licenseOMatic from 'license-o-matic';
+export class License extends FileBase {
+    constructor(project, { copyrightHolder, filename = 'license', spdx, year }) {
+        super(project, filename, {
+            marker: false,
+            committed: true,
+        });
+        _License_text.set(this, void 0);
+        __classPrivateFieldSet(this, _License_text, licenseOMatic.getLicense(spdx.toLowerCase())({
+            copyrightHolder,
+            year,
+        }), "f");
+    }
+    synthesizeContent(_) {
+        return __classPrivateFieldGet(this, _License_text, "f");
+    }
+}
+_License_text = new WeakMap();
+//# 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,EAAE,QAAQ,EAA2B,MAAM,QAAQ,CAAA;AAC1D,OAAO,aAA4B,MAAM,iBAAiB,CAAA;AA0B1D,MAAM,OAAO,OAAQ,SAAQ,QAAQ;IAGnC,YACE,OAAgB,EAChB,EAAE,eAAe,EAAE,QAAQ,GAAG,SAAS,EAAE,IAAI,EAAE,IAAI,EAAkB;QAErE,KAAK,CAAC,OAAO,EAAE,QAAQ,EAAE;YACvB,MAAM,EAAE,KAAK;YACb,SAAS,EAAE,IAAI;SAChB,CAAC,CAAA;QATJ,gCAAa;QAWX,uBAAA,IAAI,iBAAS,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;YACxD,eAAe;YACf,IAAI;SACL,CAAC,MAAA,CAAA;IACJ,CAAC;IAES,iBAAiB,CAAC,CAAY;QACtC,OAAO,uBAAA,IAAI,qBAAM,CAAA;IACnB,CAAC;CACF"}

package/license

@@ -0,0 +1,10 @@
+
+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,35 @@
+{
+  "name": "@langri-sha/projen-license",
+  "version": "0.1.0",
+  "license": "MIT",
+  "author": {
+    "name": "Filip Dupanović",
+    "email": "filip.dupanovic@gmail.com",
+    "url": "https://langri-sha.com",
+    "organization": false
+  },
+  "type": "module",
+  "main": "lib/index.js",
+  "scripts": {
+    "prepublishOnly": "rm -rf lib; tsc --project tsconfig.build.json"
+  },
+  "dependencies": {
+    "license-o-matic": "^1.2.0"
+  },
+  "devDependencies": {
+    "@langri-sha/jest-test": "0.7.1",
+    "@langri-sha/tsconfig": "0.9.0",
+    "projen": "0.81.15"
+  },
+  "peerDependencies": {
+    "projen": "^0.81.15"
+  },
+  "engines": {
+    "node": ">= 20.12.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "//": "~~ Generated by projen. To modify, edit .projenrc.mts and run \"npx projen\".",
+  "types": "lib/index.d.ts"
+}

package/readme

@@ -0,0 +1,32 @@
+# @langri-sha/projen-license
+
+A [projen] component for generating license files using [`license-o-matic`].
+
+## Usage
+
+Install dependencies:
+
+```sh
+npm install -D projen @langri-sha/projen-license
+```
+
+Then, create an `License` component for your projects:
+
+```js
+import { Project } from 'projen'
+import { License } from '@langri-sha/license'
+
+const project = new Project({
+  name: 'my-project',
+})
+
+new License(project, {
+  filename: 'license',
+  spdx: 'MIT',
+  copyrightHolder: 'John Smith <john.smith@example.com>',
+  copyrightYear: '2000',
+})
+```
+
+[license-o-matic]: https://www.npmjs.com/package/license-o-matic
+[projen]: https://projen.io/

package/src/index.ts

@@ -0,0 +1,49 @@
+import { FileBase, type IResolver, Project } from 'projen'
+import licenseOMatic, { type Spdx } from 'license-o-matic'
+
+export interface LicenseOptions {
+  /**
+   * Name of tile license file.
+   *
+   * @default "license"
+   */
+  readonly filename?: string
+
+  /**
+   * License identifier.
+   */
+  readonly spdx: Spdx | string
+
+  /**
+   * Copyright year.
+   */
+  readonly year: string
+
+  /**
+   * Copyright holder.
+   */
+  readonly copyrightHolder: string
+}
+
+export class License extends FileBase {
+  #text: string
+
+  constructor(
+    project: Project,
+    { copyrightHolder, filename = 'license', spdx, year }: LicenseOptions,
+  ) {
+    super(project, filename, {
+      marker: false,
+      committed: true,
+    })
+
+    this.#text = licenseOMatic.getLicense(spdx.toLowerCase())({
+      copyrightHolder,
+      year,
+    })
+  }
+
+  protected synthesizeContent(_: IResolver): string | undefined {
+    return this.#text
+  }
+}

package/src/license.d.ts

@@ -0,0 +1,29 @@
+declare module 'license-o-matic' {
+  export type Spdx =
+    | 'mit'
+    | 'apache-2.0'
+    | 'gpl-3.0-only'
+    | 'mpl-2.0'
+    | 'unlicense'
+    | 'lgpl-3.0-only'
+    | 'isc'
+    | 'abstyles-license'
+    | 'academic-free-license-v3'
+    | 'apple-public-source-license-2.0'
+    | 'attribution-assurance-license'
+    | 'bsd-zero-clause-license'
+    | 'eclipse-public-license-version-2.0'
+    | 'educational-community-license-v-2.0(ecl-2.0).js'
+    | 'mozilla-public-license-2.0(mpl-2.0)'
+    | 'open-software-license-3.0(osl-3.0)'
+    | 'sun-public-license-version-1.0(spl-1.0)'
+
+  const _default: {
+    getIdentifiers(): Spdx[]
+    getLicense(
+      spdx: Spdx | string,
+    ): ({ copyrightHolder: string, year: string }) => string
+  }
+
+  export = _default
+}