react-ag-psd-psdtool 1.0.0

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2025 34j
+Copyright (c) 2023 Ryan Sonshine
+
+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/README.md

@@ -0,0 +1,117 @@
+# react-ag-psd-psdtool
+
+Zero-knowledge ***minimalistic*** template for creating a new npm package.
+
+---
+
+**📘Docs Demo**: [https://34j.github.io/react-ag-psd-psdtool/](https://34j.github.io/react-ag-psd-psdtool/)
+
+**📦️NPM Package Demo**: [https://www.npmjs.com/package/react-ag-psd-psdtool](https://www.npmjs.com/package/react-ag-psd-psdtool)
+
+---
+
+## Features
+
+- The **proof** that the config is ***minimalistic*** is shown below.
+- The main reason (`☆`) of the slight complexity is the need to specify the project structure (`src`, `dist`, `test`).
+
+- 👾Github
+  - [📦🚀semantic-release](https://github.com/semantic-release/semantic-release) & [Commitizen](https://github.com/search?q=commitizen): from [this article](https://zenn.dev/wakamsha/articles/learn-semantic-release)
+  - [New Issue Templates](https://github.com/34j/react-ag-psd-psdtool/tree/main/.github/ISSUE_TEMPLATE): from [browniebroke/pypackage-template](https://github.com/browniebroke/pypackage-template/tree/main/.github/ISSUE_TEMPLATE)
+  - [💨GitHub Actions](https://github.com/34j/react-ag-psd-psdtool/tree/main/.github/workflows) + [📊Codecov](https://about.codecov.io/): npm version of [browniebroke/pypackage-template](https://github.com/browniebroke/pypackage-template/blob/main/.github/workflows/ci.yml)
+  - [🧱Renovate](https://docs.renovatebot.com/): inherits [config:best-practices](https://docs.renovatebot.com/presets-config/#configbest-practices)
+- [⚙TypeScript](https://www.typescriptlang.org/):`tsconfig.json`: inherits [@tsconfig/strictest](https://www.npmjs.com/package/@tsconfig/strictest): 4 lines for `☆`, [3 lines for ES types](https://youtu.be/H91aqUHn8sE?t=148)
+- ✨️Formatting
+  - [⚠️pre-commit](https://pre-commit.com/) and [pre-commit.ci](https://pre-commit.ci/): from [browniebroke/pypackage-template](https://github.com/browniebroke/pypackage-template/tree/main/.github/ISSUE_TEMPLATE) + [mirrors-eslint](https://github.com/pre-commit/mirrors-eslint) (⏪️[🐶Husky](https://github.com/typicode/husky) + [Lint Staged](https://github.com/okonet/lint-staged) for better CI support)
+  - [ESLint](https://eslint.org/): inherits [@antfu/eslint-config](https://www.npmjs.com/package/@antfu/eslint-config)
+- 📦Packageing
+  - [pnpm](https://pnpm.io/) (⏪️npm)
+- ⚠️ Testing
+  - [⚡️Vitest](https://vitest.dev/) (⏪️[👢Jest](https://jestjs.io/)): several lines for browser testing (optional, can be removed if Node.js only)
+- 📖Documentation
+  - [🌐GitHub Pages](https://pages.github.com/)
+  - [📖TypeDoc](https://typedoc.org/): 2 lines for `☆` `P`
+- ❄Nix Support (Optional, only needed for Nix users)
+  - [❄`nix develop --ignore-environment`](https://nix.dev/manual/nix/latest/command-ref/new-cli/nix3-develop): many lines for Playwright support (optional, can be removed if Node.js only)
+
+<details>
+<summary>Removed Features (to achieve minimalism)</summary>
+
+- Removed Commitizen integration and VS Code stuff (from [ryansonshine/typescript-npm-package-template](https://github.com/ryansonshine/typescript-npm-package-template)) because it's not maintained and complex. Commitizen can be still used (Semantic Release supports it natively).
+- Removed Prettier due to [@antfu/eslint-config's opinions](https://github.com/antfu/eslint-config?tab=readme-ov-file#prettier) and [mirrors-prettier](https://github.com/pre-commit/mirrors-prettier) being archived.
+
+</details>
+
+## Quickstart
+
+1. Click the "Use this template" button.
+2. Replace `GITHUB_USER` and `REPO_NAME` using `sed`:
+  ```bash
+  GITHUB_USER="johnsmith"
+  REPO_NAME="my-cool-package"
+  sed -i.tmp "s/\([^@]\)34j/\1$GITHUB_USER/g; s/react-ag-psd-psdtool\|react-ag-psd-psdtool/$REPO_NAME/g;" package.json src/index.ts README.md
+  sed -i.tmp 's/"version": "[0-9.]*"/"version": "0.0.0"/' package.json
+  rm *.tmp
+  rm src/*.tmp
+  rm CHANGELOG.md
+  ```
+3. [Create](https://www.npmjs.com/settings/34j/tokens/) and add `NPM_TOKEN` to [`Settings/Secrets and variables/Actions/Repository secrets`](https://github.com/34j/react-ag-psd-psdtool/settings/secrets/actions).
+4. [Create][codecov-url] and add `CODECOV_TOKEN` to [`Settings/Secrets and variables/Actions/Repository secrets`](https://github.com/34j/react-ag-psd-psdtool/settings/secrets/actions).
+5. Install GitHub Apps, [pre-commit.ci **lite**](https://github.com/apps/pre-commit-ci-lite/installations/select_target) and [Codecov](https://github.com/apps/codecov/installations/select_target).
+6. Install [pre-commit](https://pre-commit.com/) using [`uv`](https://github.com/astral-sh/uv) by `uv tool install pre-commit` and install hooks by `pre-commit install`.
+7. Enable Github Pages and set `Source` to `GitHub Actions` from [`Settings/Pages/Build and deployment`](https://github.com/34j/react-ag-psd-psdtool/settings/pages)
+8. Remove everything above `---`.
+
+> Inspired by [node-module-boilerplate](https://github.com/sindresorhus/node-module-boilerplate) and [typescript-npm-package-template](https://github.com/Atry/typescript-npm-package-template/tree/main), which is great but unnecessarily complex and poorly maintained.
+
+---
+
+# react-ag-psd-psdtool
+
+[![npm package][npm-img]][npm-url]
+[![Build Status][build-img]][build-url]
+[![Downloads][downloads-img]][downloads-url]
+[![Issues][issues-img]][issues-url]
+[![Code Coverage][codecov-img]][codecov-url]
+[![Commitizen Friendly][commitizen-img]][commitizen-url]
+[![Semantic Release][semantic-release-img]][semantic-release-url]
+
+---
+
+**📘Documentation**: [https://34j.github.io/react-ag-psd-psdtool/](https://34j.github.io/react-ag-psd-psdtool/)
+
+**📦️NPM Package**: [https://www.npmjs.com/package/react-ag-psd-psdtool](https://www.npmjs.com/package/react-ag-psd-psdtool)
+
+---
+
+TODO: Project Description.
+
+## Installation
+
+```bash
+npm install react-ag-psd-psdtool
+```
+
+## Usage
+
+```ts
+import { myPackage } from 'react-ag-psd-psdtool'
+
+myPackage('hello')
+// => 'hello from my package'
+```
+
+[build-img]:https://github.com/34j/react-ag-psd-psdtool/actions/workflows/release.yml/badge.svg
+[build-url]:https://github.com/34j/react-ag-psd-psdtool/actions/workflows/release.yml
+[downloads-img]:https://img.shields.io/npm/dt/react-ag-psd-psdtool
+[downloads-url]:https://www.npmtrends.com/react-ag-psd-psdtool
+[npm-img]:https://img.shields.io/npm/v/react-ag-psd-psdtool
+[npm-url]:https://www.npmjs.com/package/react-ag-psd-psdtool
+[issues-img]:https://img.shields.io/github/issues/34j/react-ag-psd-psdtool
+[issues-url]:https://github.com/34j/react-ag-psd-psdtool/issues
+[codecov-img]:https://codecov.io/gh/34j/react-ag-psd-psdtool/branch/main/graph/badge.svg
+[codecov-url]:https://codecov.io/gh/34j/react-ag-psd-psdtool
+[semantic-release-img]:https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
+[semantic-release-url]:https://github.com/semantic-release/semantic-release
+[commitizen-img]:https://img.shields.io/badge/commitizen-friendly-brightgreen.svg
+[commitizen-url]:http://commitizen.github.io/cz-cli/

package/dist/src/index.d.ts

@@ -0,0 +1,9 @@
+/**
+  @module
+ */
+import { mySubmodule } from './submodule';
+/**
+ * Lorem ipsum.
+ */
+export declare const myPackage: (taco?: string) => string;
+export { mySubmodule };

package/dist/src/index.js

@@ -0,0 +1,13 @@
+"use strict";
+/**
+  @module
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mySubmodule = exports.myPackage = void 0;
+const submodule_1 = require("./submodule");
+Object.defineProperty(exports, "mySubmodule", { enumerable: true, get: function () { return submodule_1.mySubmodule; } });
+/**
+ * Lorem ipsum.
+ */
+const myPackage = (taco = '') => `${taco} from my package`;
+exports.myPackage = myPackage;

package/dist/src/submodule/index.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Lorem ipsum.
+ */
+export declare const mySubmodule: (taco?: string) => string;

package/dist/src/submodule/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mySubmodule = void 0;
+/**
+ * Lorem ipsum.
+ */
+const mySubmodule = (taco = '') => `${taco} from my submodule`;
+exports.mySubmodule = mySubmodule;

package/package.json

@@ -0,0 +1,88 @@
+{
+  "name": "react-ag-psd-psdtool",
+  "type": "commonjs",
+  "version": "1.0.0",
+  "description": "Minimalistic npm package template with 📦🚀semantic-release + Commitizen, CodeCov, Renovate, pre-commit + EsLint (✗🐶Husky + Lint Staged), ⚡️Vitest (✗👢Jest), 📖TypeDoc + Github Pages support. Note that this is a generated sample package.",
+  "author": {
+    "name": "34j"
+  },
+  "license": "MIT",
+  "homepage": "https://github.com/34j/react-ag-psd-psdtool",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/34j/react-ag-psd-psdtool.git"
+  },
+  "bugs": {
+    "url": "https://github.com/34j/react-ag-psd-psdtool/issues"
+  },
+  "keywords": [
+    "boilerplate",
+    "template",
+    "typescript",
+    "vitest",
+    "pre-commit",
+    "semantic-release",
+    "typedoc"
+  ],
+  "main": "dist/src/index.js",
+  "types": "dist/src/index.d.ts",
+  "files": [
+    "dist/src/**/*"
+  ],
+  "scripts": {
+    "build:watch": "tsc --watch --project tsconfig.json",
+    "preinstall": "npx only-allow pnpm",
+    "build": "tsc --project tsconfig.json",
+    "lint": "eslint --fix",
+    "typedoc": "typedoc",
+    "typedoc:watch": "typedoc --watch",
+    "test:watch": "vitest --watch --coverage --coverage.include=src",
+    "test": "vitest --coverage --coverage.include=src",
+    "watch": "npm-run-all --race --parallel *:watch",
+    "update": "npm-check-updates -u"
+  },
+  "devDependencies": {
+    "@antfu/eslint-config": "5.3.0",
+    "@semantic-release/changelog": "6.0.3",
+    "@semantic-release/git": "10.0.1",
+    "@tsconfig/strictest": "2.0.5",
+    "@types/node": "22.18.1",
+    "@typescript-eslint/eslint-plugin": "8.43.0",
+    "@vitest/browser": "3.2.4",
+    "@vitest/coverage-v8": "3.2.4",
+    "eslint": "9.35.0",
+    "npm-run-all2": "8.0.4",
+    "playwright": "1.55.0",
+    "semantic-release": "24.2.8",
+    "typedoc": "0.28.12",
+    "typescript": "5.9.2",
+    "vitest": "3.2.4"
+  },
+  "typedocOptions": {
+    "entryPoints": [
+      "src"
+    ],
+    "tsconfig": "tsconfig.json",
+    "headings": false
+  },
+  "release": {
+    "plugins": [
+      "@semantic-release/commit-analyzer",
+      "@semantic-release/release-notes-generator",
+      "@semantic-release/changelog",
+      "@semantic-release/npm",
+      [
+        "@semantic-release/git",
+        {
+          "assets": [
+            "CHANGELOG.md",
+            "README.md",
+            "package.json",
+            "package-lock.json"
+          ]
+        }
+      ],
+      "@semantic-release/github"
+    ]
+  }
+}