chore: organize npm package repository structure

[Copilot]

The repository was missing standard npm package hygiene — no LICENSE, minimal .gitignore, incomplete package.json metadata, no CI, and build artifacts committed to git.

Changes

• LICENSE — Added MIT LICENSE (was absent)
• .gitignore — Expanded to ignore dist/, log files, .env, .DS_Store
• package.json — Added license, repository, bugs, homepage, engines fields; author now includes email
• README.md — Fixed hardcoded version (1.0.8 → 1.0.11); expanded Contributing section with dev setup and PR workflow steps
• .github/workflows/ci.yml — New CI workflow: runs npm ci + npm run build across Node.js 18/20/22 on push/PR to main, with explicit permissions: contents: read
• dist/ removed from git — Build artifacts are no longer tracked; "files": ["dist"] in package.json already ensures correct npm publish content

Original prompt

Create a PR to organize the npm package repository.

Repository: mrashed21/bd-number-validator (public)
Base branch: main

Goals:

1. Improve repository structure and maintainability for an npm package.
2. Ensure npm publish content is clean and intentional.
3. Add/Improve documentation and GitHub workflow.

Tasks (do as applicable based on current repo state):

• Update/expand README.md with clear description, installation, usage examples, API, and contribution notes.
• Ensure package.json metadata is complete and correct (name, version, description, keywords, repository, bugs, homepage, license, engines, main/exports/types as appropriate).
• Add LICENSE file if missing (prefer MIT unless existing license dictates otherwise).
• Add .gitignore if missing.
• Add npm packaging hygiene: use "files" field and/or .npmignore so only needed artifacts are published.
• Add GitHub Actions CI workflow to run tests/lint on push/PR (Node matrix if sensible).
• Add basic formatting/lint tooling only if repo already uses it or minimal setup is appropriate.
• Avoid breaking API; keep changes backward-compatible.

Deliverables:

• A pull request with all changes.
• Brief PR description summarizing changes and how to test.

The following is the prior conversation context from the user's chat exploration (may be truncated):

User: amar ei repo npm er package, abong npm e publish kora ache kintu ei repo organige kora nai, kivbae eita organize kora jabe, tumi kore dao

Assistant: Repo ta “organize” korte সাধারণত 2টা জিনিস বোঝায়—(1) GitHub repo structure/metadata গুছানো, (2) npm package publish/release workflow গুছানো। আমি তোমার জন্য এগুলো করে দিতে পারি, কিন্তু আগে ২টা তথ্য লাগবে (না হলে ভুল repo/branch এ change হয়ে যেতে পারে):

1. তুমি কি চাও আমি GitHub এ PR খুলে সব organizing changes করে দিই? (হ্যাঁ/না)
2. এই repo-র default branch কোনটা (main/master/develop)? (না জানলে আমি দেখে নিতে পারি)

তুমি “হ্যাঁ, PR খুলে দাও” বললেই আমি সাধারণত এগুলো organize করে দিই:

• README.md সুন্দর করা (install, usage, examples, API, validation rules)
• package.json cleanup (name, description, keywords, repository, bugs, homepage, exports/main/types, engines, files, license)
• LICENSE যোগ/ঠিক করা
• .gitignore, .npmignore বা files field ঠিক করা যাতে অপ্রয়োজনীয় ফাইল publish না হয়
• Versioning + changelog (CHANGELOG.md) + conventional commits (ঐচ্ছিক)
• CI: GitHub Actions দিয়ে npm test/lint রান + optional npm publish workflow (npm token লাগবে)
• Release/tagging guideline (GitHub Releases + npm version sync)
• Code formatting (prettier/eslint) (যদি দরকার হয়)
• Folder structure (src/, test/, dist/) এবং build step (যদি TypeScript/compile থাকে)

আরেকটা প্রশ্ন: তুমি “organize” বলতে কি repo-টা GitHub Organization-এ (ব্যক্তিগত account থেকে org এ) move করতে চাও?

• যদি হ্যাঁ: কোন Organization name এ নিতে চাও? (যেমন my-org)
• আর তোমার org-এ move করার permission আছে তো?

যে ৩টা জিনিসের উত্তর দিলেই আমি এগোতে পারব:

1. PR খুলব? (হ্যাঁ/না)
2. default branch কোনটা?
3. “organize” = repo structure/workflow, নাকি GitHub Organization-এ move—কোনটা?

User: PR খুলব? (না)
default branch (main)
“organize” = repo structure/workflow

Assistant: আমি direct repo-টা অ্যাক্সেস করতে পারছি না (tool থেকে “Repo is inaccessible or not found” আসছে), তাই তোমার হয়ে এখনই ফাইল পরিবর্তন/organize করে দিতে পারছি না।

তুমি PR চাইছো না—তাই “আমি করে দাও” টাইপ কাজ করতে হলে ২টা অপশন আছে:

Option A (সবচেয়ে সহজ): আমি তোমাকে exact ফাইল কনটেন্ট দিই, তুমি copy-paste করে push করবে

তুমি শুধু এগুলো এখানে paste করো:

1. package.json
2. বর্তমান README.md (থাকলে)
3. repo root-এর ফাইল লিস্ট (screenshots/ls output)

তাহলে আমি তোমার package অনুযায়ী ready-to-commit version বানিয়ে দেব:

• উন্নত README.md (install, usage, examples, API)
• LICENSE (তুমি কোনটা চাও: MIT/ISC/Apache-2.0?)
• .gitignore
• .github/workflows/ci.yml (test/lint থাকলে run করবে)
• CHANGELOG.md (optional)
• package.json polish (repository/bugs/homepage/keywords/files/engines)

Option B: তুমি আমাকে repo access দাও, আমি commit করে দেব (PR ছাড়াই)

এটার জন্য repo-টা public করতে হবে অথবা আমাকে collaborator access দিতে হবে।
এখন repo visible না বলে আমি কিছুই read/write করতে পারছি না।

দ্রুত চেকলিস্ট (তুমি যেটা confirm করবে)

1. Repo কি private? (হ্যাঁ হলে—public করবে নাকি আমাকে collaborator দেবে?)
2. Packageটা JS নাকি TS? (build step আছে? dist/ হয়?)
3. npm test/npm run lint আছে? (scripts list দিলেই হবে)
4. License কোনটা চাও? (MIT সাধারণ)

যদি তুমি Option A নিতে চাও, এখনই package.jsonটা paste করো—আমি আগে সেটার ভিত্তিতে organized package.json + README skeleton তৈরি করে দিচ্ছি।

User: @mrashed21/bd-number-validator repo public , thik ache tumi PR dao

Assistant: আমি এখন PR তৈরি/আপডেট করার প্রসেসটা চালিয়ে যেতে তোমার কনফার্মেশনের অপেক্ষায় আছি—তুমি অনুমতি দিলেই পরের ধাপগুলো এগোব।

This pull request was created from Copilot chat.

[qodo-code-review]

Review Summary by Qodo

Organize npm package repository structure and add CI/CD workflow

✨ Enhancement 📝 Documentation

Walkthroughs

Description

• Added MIT LICENSE file for legal compliance
• Expanded .gitignore to exclude build artifacts and environment files
• Enhanced package.json metadata with license, repository, bugs, homepage, and engines fields
• Updated README version and added development setup and PR workflow documentation
• Implemented GitHub Actions CI workflow for Node.js 18/20/22 matrix testing
• Removed dist/ build artifacts from git tracking

Diagram

flowchart LR
  A["Repository Setup"] --> B["License & Metadata"]
  A --> C["Git Configuration"]
  A --> D["Documentation"]
  A --> E["CI/CD Pipeline"]
  B --> F["LICENSE file<br/>package.json metadata"]
  C --> G[".gitignore expansion<br/>Remove dist/ artifacts"]
  D --> H["README updates<br/>Dev setup & PR guide"]
  E --> I["GitHub Actions workflow<br/>Node 18/20/22 matrix"]

Loading

File Changes

1. LICENSE 📝 Documentation +21/-0

Added MIT license file

LICENSE

---

2. package.json ⚙️ Configuration changes +13/-1

Enhanced metadata and configuration fields

package.json

---

3. README.md 📝 Documentation +23/-1

Updated version and added development guide

README.md

---

View more (11)

4. .github/workflows/ci.yml ⚙️ Configuration changes +33/-0

Added GitHub Actions CI workflow

.github/workflows/ci.yml

---

5. dist/index.d.ts Miscellaneous +0/-14

Removed build artifact from tracking

dist/index.d.ts

---

6. dist/react.d.ts Miscellaneous +0/-33

Removed build artifact from tracking

dist/react.d.ts

---

7. dist/react.css Miscellaneous +0/-46

Removed build artifact from tracking

dist/react.css

---

8. dist/chunk-DVWXJMTU.js Miscellaneous +0/-202

Removed build artifact from tracking

dist/chunk-DVWXJMTU.js

---

9. dist/index.cjs Miscellaneous +0/-232

Removed build artifact from tracking

dist/index.cjs

---

10. dist/index.d.cts Miscellaneous +0/-14

Removed build artifact from tracking

dist/index.d.cts

---

11. dist/index.js Miscellaneous +0/-10

Removed build artifact from tracking

dist/index.js

---

12. dist/react.cjs Miscellaneous +0/-230

Removed build artifact from tracking

dist/react.cjs

---

13. dist/react.d.cts Miscellaneous +0/-33

Removed build artifact from tracking

dist/react.d.cts

---

14. dist/react.js Miscellaneous +0/-8

Removed build artifact from tracking

dist/react.js

---

[qodo-code-review]

Code Review by Qodo

🐞 Bugs (2) 📘 Rule violations (0)

1. Node 16 untested 🐞 Bug ☼ Reliability

Description

package.json declares Node.js >=16 support, but the new CI matrix only runs on Node 18/20/22, so
Node 16 regressions can merge undetected. This is especially risky now that CI is the primary
guardrail for declared compatibility.

Code

package.json[R15-17]

+  "engines": {
+    "node": ">=16"
+  },

Evidence

The repo now claims compatibility with Node 16+, but CI does not exercise Node 16 at all, so the
claim isn’t validated by automation.

package.json[15-17]
.github/workflows/ci.yml[16-18]

Agent prompt

The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

### Issue description
CI should test the minimum Node version declared in `engines.node` (or the `engines` value should be raised) to avoid shipping untested compatibility.

### Issue Context
- `package.json` declares `node: ">=16"`.
- GitHub Actions CI only runs on 18/20/22.

### Fix Focus Areas
- .github/workflows/ci.yml[16-18]
- package.json[15-17]

### Suggested change
- Either add `16.x` to the CI matrix, **or** change `engines.node` to `>=18` (or whatever is intended to be supported/tested).

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

---

2. Install misses build tool 🐞 Bug ☼ Reliability

Description

After removing tracked dist/ artifacts, package entrypoints still reference dist/*, and
prepare runs a tsup build that is only present in devDependencies; installs that omit
devDependencies can fail and leave dist/ missing. That results in broken imports because
main/module/types/exports point into dist/.

Code

dist/index.cjs[L1-5]

-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;

Evidence

dist/ is no longer committed and is ignored by git, yet all runtime/type entrypoints target
dist/*. The repo relies on prepare -> build -> tsup, but tsup is only a devDependency, which
can be absent in installs that omit devDependencies (making prepare unable to create dist/).

.gitignore[1-3]
package.json[18-21]
package.json[41-51]
package.json[55-58]
package.json[63-71]

Agent prompt

The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

### Issue description
The repo no longer contains `dist/`, but entrypoints require it. The current approach relies on `prepare` to build `dist/`, yet the build tool (`tsup`) is only in `devDependencies`, so installs that omit dev deps can fail.

### Issue Context
- `dist/` is ignored and no longer tracked.
- `main/module/types/exports` all point into `dist/*`.
- `prepare` runs `npm run build` and `build` uses `tsup`.
- `tsup` is in `devDependencies`.

### Fix Focus Areas
- package.json[18-21]
- package.json[41-51]
- package.json[55-58]
- package.json[63-71]
- .gitignore[1-3]

### Suggested fix options (pick one)
1) **Preferable for npm-published packages:** move the build hook from `prepare` to `prepack` (or `prepublishOnly`) so building happens for `npm pack/publish` but not during install, and ensure your publish flow always runs the build.
2) **If you want git installs to work reliably:** keep `prepare`, but ensure the build tooling needed by `prepare` is available (e.g., document that dev deps are required, or move required tooling to `dependencies`, understanding the tradeoff).

### Acceptance criteria
- A fresh checkout + an install mode that omits dev deps does not attempt (and fail) to build.
- Published artifacts still include `dist/` matching the declared entrypoints.

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

---