@langri-sha/projen-readme 0.1.0

package/CHANGELOG.json

@@ -0,0 +1,48 @@
+{
+  "name": "@langri-sha/projen-readme",
+  "entries": [
+    {
+      "date": "Fri, 26 Jul 2024 20:58:04 GMT",
+      "version": "0.1.0",
+      "tag": "@langri-sha/projen-readme_v0.1.0",
+      "comments": {
+        "minor": [
+          {
+            "author": "filip.dupanovic@gmail.com",
+            "package": "@langri-sha/projen-readme",
+            "commit": "d58e2b444358fb65166d0878c185220c6e0a7bb0",
+            "comment": "feat(workspace): Harden Projen component types"
+          },
+          {
+            "author": "filip.dupanovic@gmail.com",
+            "package": "@langri-sha/projen-readme",
+            "commit": "d58e2b444358fb65166d0878c185220c6e0a7bb0",
+            "comment": "feat(readme): Add `ReadmeFile`"
+          }
+        ],
+        "none": [
+          {
+            "author": "filip.dupanovic@gmail.com",
+            "package": "@langri-sha/projen-readme",
+            "commit": "d58e2b444358fb65166d0878c185220c6e0a7bb0",
+            "comment": "feat(projen): Add Git ignore patterns"
+          },
+          {
+            "author": "filip.dupanovic@gmail.com",
+            "package": "@langri-sha/projen-readme",
+            "commit": "d58e2b444358fb65166d0878c185220c6e0a7bb0",
+            "comment": "feat(workspace): Migrate documentation pathnames"
+          }
+        ],
+        "patch": [
+          {
+            "author": "email not defined",
+            "package": "@langri-sha/projen-readme",
+            "commit": "d58e2b444358fb65166d0878c185220c6e0a7bb0",
+            "comment": "chore(deps): chore(deps): update dependency projen to v0.84.6"
+          }
+        ]
+      }
+    }
+  ]
+}

package/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Change Log - @langri-sha/projen-readme
+
+This log was last generated on Fri, 26 Jul 2024 20:58:04 GMT and should not be manually modified.
+
+<!-- Start content -->
+
+## 0.1.0
+
+Fri, 26 Jul 2024 20:58:04 GMT
+
+### Minor changes
+
+- feat(workspace): Harden Projen component types (filip.dupanovic@gmail.com)
+- feat(readme): Add `ReadmeFile` (filip.dupanovic@gmail.com)
+
+### Patches
+
+- chore(deps): chore(deps): update dependency projen to v0.84.6 (email not defined)

package/dist/index.d.ts

@@ -0,0 +1,14 @@
+import { Project, SampleFile } from 'projen';
+/**
+ * Initial `README` for new packages.
+ */
+export interface ReadmeFileOptions {
+    readonly filename?: string;
+}
+/**
+ * Initial `README` for new packages.
+ */
+export declare class ReadmeFile extends SampleFile {
+    constructor(project: Project, { filename }?: ReadmeFileOptions);
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAA;AAE5C;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAC3B;AAED;;GAEG;AACH,qBAAa,UAAW,SAAQ,UAAU;gBAEtC,OAAO,EAAE,OAAO,EAChB,EAAE,QAAsB,EAAE,GAAE,iBAAsB;CAMrD"}

package/dist/index.js

@@ -0,0 +1,12 @@
+import { SampleFile } from 'projen';
+/**
+ * Initial `README` for new packages.
+ */
+export class ReadmeFile extends SampleFile {
+    constructor(project, { filename = 'README.md' } = {}) {
+        super(project, filename, {
+            contents: `# ${project.name}\n`,
+        });
+    }
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAW,UAAU,EAAE,MAAM,QAAQ,CAAA;AAS5C;;GAEG;AACH,MAAM,OAAO,UAAW,SAAQ,UAAU;IACxC,YACE,OAAgB,EAChB,EAAE,QAAQ,GAAG,WAAW,KAAwB,EAAE;QAElD,KAAK,CAAC,OAAO,EAAE,QAAQ,EAAE;YACvB,QAAQ,EAAE,KAAK,OAAO,CAAC,IAAI,IAAI;SAChC,CAAC,CAAA;IACJ,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,36 @@
+{
+  "name": "@langri-sha/projen-readme",
+  "version": "0.1.0",
+  "bugs": {
+    "url": "https://github.com/langri-sha/langri-sha.com/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/langri-sha/langri-sha.com.git",
+    "directory": "packages/projen-readme"
+  },
+  "license": "MIT",
+  "author": {
+    "name": "Filip Dupanović",
+    "email": "filip.dupanovic@gmail.com",
+    "url": "https://langri-sha.com",
+    "organization": false
+  },
+  "type": "module",
+  "main": "dist/index.js",
+  "scripts": {
+    "prepublishOnly": "rm -rf dist; tsc --project tsconfig.build.json"
+  },
+  "devDependencies": {
+    "@langri-sha/tsconfig": "0.10.1",
+    "@langri-sha/vitest": "0.1.1"
+  },
+  "peerDependencies": {
+    "projen": "^0.84.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "//": "~~ Generated by projen. To modify, edit .projenrc.ts and run \"npx projen\".",
+  "types": "dist/index.d.ts"
+}

package/readme.md

@@ -0,0 +1,28 @@
+# @langri-sha/readme
+
+A [projen] component for creating sample [`README` files].
+
+## Usage
+
+Install dependencies:
+
+```sh
+npm install -D @langri-sha/readme
+```
+
+Then, create a `README` component for your projects:
+
+```js
+import { Project } from 'projen'
+import { ReadmeFile } from '@langri-sha/readme'
+
+const project = new Project({
+  name: 'my-project',
+})
+
+new ReadmeFile(project)
+```
+
+[readme files]:
+  https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes
+[projen]: https://projen.io/

package/src/index.ts

@@ -0,0 +1,22 @@
+import { Project, SampleFile } from 'projen'
+
+/**
+ * Initial `README` for new packages.
+ */
+export interface ReadmeFileOptions {
+  readonly filename?: string
+}
+
+/**
+ * Initial `README` for new packages.
+ */
+export class ReadmeFile extends SampleFile {
+  constructor(
+    project: Project,
+    { filename = 'README.md' }: ReadmeFileOptions = {},
+  ) {
+    super(project, filename, {
+      contents: `# ${project.name}\n`,
+    })
+  }
+}