From 336d127f9ce40c73893ed578584465c70dd48e77 Mon Sep 17 00:00:00 2001
From: Alessio Frittoli <35973186+alessiofrittoli@users.noreply.github.com>
Date: Fri, 17 Jan 2025 19:03:33 +0100
Subject: [PATCH] Initial commit
---
.editorconfig | 15 +
.env.test | 1 +
.github/rulesets/Default branch ruleset.json | 82 +
.github/rulesets/Tagging ruleset.json | 55 +
.github/workflows/tests-ci.yml | 35 +
.gitignore | 7 +
.npmignore | 19 +
.vscode/extensions.json | 13 +
.vscode/launch.json | 24 +
.vscode/settings.json | 13 +
CODE_OF_CONDUCT.md | 49 +
CONTRIBUTING.md | 94 +
README.md | 168 +
__tests__/jest.test.ts | 24 +
eslint.config.mjs | 25 +
jest.config.ts | 37 +
jest.setup.ts | 3 +
license.md | 21 +
package.json | 70 +
pnpm-lock.yaml | 5011 ++++++++++++++++++
scripts/publish.js | 2 +
src/index.ts | 1 +
tsconfig.json | 30 +
tsup.config.ts | 13 +
24 files changed, 5812 insertions(+)
create mode 100644 .editorconfig
create mode 100644 .env.test
create mode 100644 .github/rulesets/Default branch ruleset.json
create mode 100644 .github/rulesets/Tagging ruleset.json
create mode 100644 .github/workflows/tests-ci.yml
create mode 100644 .gitignore
create mode 100644 .npmignore
create mode 100644 .vscode/extensions.json
create mode 100644 .vscode/launch.json
create mode 100644 .vscode/settings.json
create mode 100644 CODE_OF_CONDUCT.md
create mode 100644 CONTRIBUTING.md
create mode 100644 README.md
create mode 100644 __tests__/jest.test.ts
create mode 100644 eslint.config.mjs
create mode 100644 jest.config.ts
create mode 100644 jest.setup.ts
create mode 100644 license.md
create mode 100644 package.json
create mode 100644 pnpm-lock.yaml
create mode 100644 scripts/publish.js
create mode 100644 src/index.ts
create mode 100644 tsconfig.json
create mode 100644 tsup.config.ts
diff --git a/.editorconfig b/.editorconfig
new file mode 100644
index 0000000..6badf13
--- /dev/null
+++ b/.editorconfig
@@ -0,0 +1,15 @@
+root = true
+
+[*]
+indent_style = tab
+indent_size = 4
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = false
+
+[*.md]
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = false
+insert_final_newline = true
\ No newline at end of file
diff --git a/.env.test b/.env.test
new file mode 100644
index 0000000..b857a18
--- /dev/null
+++ b/.env.test
@@ -0,0 +1 @@
+VAR_LOADED=true
\ No newline at end of file
diff --git a/.github/rulesets/Default branch ruleset.json b/.github/rulesets/Default branch ruleset.json
new file mode 100644
index 0000000..3cd240f
--- /dev/null
+++ b/.github/rulesets/Default branch ruleset.json
@@ -0,0 +1,82 @@
+{
+ "name": "Default branch ruleset",
+ "target": "branch",
+ "source_type": "Repository",
+ "source": "alessiofrittoli/node-module-starter",
+ "enforcement": "active",
+ "conditions": {
+ "ref_name": {
+ "exclude": [],
+ "include": [
+ "~DEFAULT_BRANCH"
+ ]
+ }
+ },
+ "rules": [
+ {
+ "type": "deletion"
+ },
+ {
+ "type": "non_fast_forward"
+ },
+ {
+ "type": "creation"
+ },
+ {
+ "type": "update"
+ },
+ {
+ "type": "required_linear_history"
+ },
+ {
+ "type": "required_signatures"
+ },
+ {
+ "type": "pull_request",
+ "parameters": {
+ "required_approving_review_count": 0,
+ "dismiss_stale_reviews_on_push": true,
+ "require_code_owner_review": true,
+ "require_last_push_approval": true,
+ "required_review_thread_resolution": true,
+ "automatic_copilot_code_review_enabled": false,
+ "allowed_merge_methods": [
+ "squash",
+ "rebase"
+ ]
+ }
+ },
+ {
+ "type": "required_status_checks",
+ "parameters": {
+ "strict_required_status_checks_policy": true,
+ "do_not_enforce_on_create": false,
+ "required_status_checks": [
+ {
+ "context": "Run Unit Tests",
+ "integration_id": 15368
+ }
+ ]
+ }
+ },
+ {
+ "type": "code_scanning",
+ "parameters": {
+ "code_scanning_tools": [
+ {
+ "tool": "CodeQL",
+ "security_alerts_threshold": "high_or_higher",
+ "alerts_threshold": "errors"
+ }
+ ]
+ }
+ }
+ ],
+ "bypass_actors": [
+ {
+ "actor_id": 5,
+ "actor_type": "RepositoryRole",
+ "bypass_mode": "always"
+ }
+ ]
+}
\ No newline at end of file
diff --git a/.github/rulesets/Tagging ruleset.json b/.github/rulesets/Tagging ruleset.json
new file mode 100644
index 0000000..75120d9
--- /dev/null
+++ b/.github/rulesets/Tagging ruleset.json
@@ -0,0 +1,55 @@
+{
+ "name": "Tagging ruleset",
+ "target": "tag",
+ "source_type": "Repository",
+ "source": "alessiofrittoli/node-module-starter",
+ "enforcement": "active",
+ "conditions": {
+ "ref_name": {
+ "exclude": [],
+ "include": [
+ "~ALL"
+ ]
+ }
+ },
+ "rules": [
+ {
+ "type": "deletion"
+ },
+ {
+ "type": "non_fast_forward"
+ },
+ {
+ "type": "creation"
+ },
+ {
+ "type": "update"
+ },
+ {
+ "type": "required_linear_history"
+ },
+ {
+ "type": "required_signatures"
+ },
+ {
+ "type": "required_status_checks",
+ "parameters": {
+ "strict_required_status_checks_policy": true,
+ "do_not_enforce_on_create": false,
+ "required_status_checks": [
+ {
+ "context": "Run Unit Tests",
+ "integration_id": 15368
+ }
+ ]
+ }
+ }
+ ],
+ "bypass_actors": [
+ {
+ "actor_id": 5,
+ "actor_type": "RepositoryRole",
+ "bypass_mode": "always"
+ }
+ ]
+}
\ No newline at end of file
diff --git a/.github/workflows/tests-ci.yml b/.github/workflows/tests-ci.yml
new file mode 100644
index 0000000..a3322b1
--- /dev/null
+++ b/.github/workflows/tests-ci.yml
@@ -0,0 +1,35 @@
+on: [ "push", "pull_request" ]
+
+name: Unit Tests
+
+jobs:
+ test:
+ name: Run Unit Tests
+ runs-on: ubuntu-latest
+ permissions:
+ contents: read
+ pull-requests: write
+ steps:
+
+ - uses: actions/checkout@v4
+
+ - name: Use Node.js 20.x
+ uses: actions/setup-node@v3
+ with:
+ node-version: 20.x
+
+ - name: Install dependencies
+ run: |
+ npm install -g pnpm@latest
+ pnpm i
+
+ - name: Run tests
+ run: |
+ pnpm test:ci:coverage
+
+ - name: Report to Coveralls
+ uses: coverallsapp/github-action@v2
+ with:
+ github-token: ${{ secrets.COVERALLS_REPO_TOKEN }}
+ file: coverage/lcov.info
+ allow-empty: true
\ No newline at end of file
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..d3775ea
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,7 @@
+/dist
+/node_modules
+/coverage
+
+.env.*
+!.env.test
+.DS_Store
\ No newline at end of file
diff --git a/.npmignore b/.npmignore
new file mode 100644
index 0000000..d48d587
--- /dev/null
+++ b/.npmignore
@@ -0,0 +1,19 @@
+/src
+/__tests__
+/docs
+/coverage
+/scripts
+
+/node_modules
+/.git
+/.github
+
+.gitignore
+.env.*
+.DS_Store
+
+eslint.config.mjs
+jest.config.ts
+jest.setup.ts
+tsconfig.json
+tsup.config.ts
\ No newline at end of file
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
new file mode 100644
index 0000000..48def25
--- /dev/null
+++ b/.vscode/extensions.json
@@ -0,0 +1,13 @@
+{
+ // See https://go.microsoft.com/fwlink/?LinkId=827846 to learn about workspace recommendations.
+ // Extension identifier format: ${publisher}.${name}. Example: vscode.csharp
+
+ // List of extensions which should be recommended for users of this workspace.
+ "recommendations": [
+ "dbaeumer.vscode-eslint",
+ "davidanson.vscode-markdownlint",
+ "Orta.vscode-jest",
+ ],
+ // List of extensions recommended by VS Code that should not be recommended for users of this workspace.
+ "unwantedRecommendations": []
+}
\ No newline at end of file
diff --git a/.vscode/launch.json b/.vscode/launch.json
new file mode 100644
index 0000000..1abfab5
--- /dev/null
+++ b/.vscode/launch.json
@@ -0,0 +1,24 @@
+{
+ "configurations": [
+ {
+ "type": "node",
+ "name": "vscode-jest-tests.v2.node-module-starter",
+ "request": "launch",
+ "args": [
+ "test",
+ "--",
+ "--runInBand",
+ "--watchAll=false",
+ "--testNamePattern",
+ "${jest.testNamePattern}",
+ "--runTestsByPath",
+ "${jest.testFile}"
+ ],
+ "console": "integratedTerminal",
+ "internalConsoleOptions": "neverOpen",
+ "disableOptimisticBPs": true,
+ "runtimeExecutable": "pnpm",
+ "program": "${workspaceFolder}/node_modules/jest/bin/jest.js"
+ }
+ ]
+}
\ No newline at end of file
diff --git a/.vscode/settings.json b/.vscode/settings.json
new file mode 100644
index 0000000..4d1bc24
--- /dev/null
+++ b/.vscode/settings.json
@@ -0,0 +1,13 @@
+{
+ "workbench.colorCustomizations": {
+ "titleBar.activeBackground": "#212121",
+ "titleBar.border": "#CB3837",
+ "titleBar.activeForeground": "#F0F0F0",
+ "statusBar.background": "#212121",
+ "statusBar.border":"#CB3837",
+ "statusBar.foreground": "#F0F0F0",
+ "activityBar.activeBorder": "#CB3837",
+ "activityBarBadge.foreground":"#F0F0F0",
+ "activityBarBadge.background":"#CB3837",
+ },
+}
\ No newline at end of file
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
new file mode 100644
index 0000000..a29b2ed
--- /dev/null
+++ b/CODE_OF_CONDUCT.md
@@ -0,0 +1,49 @@
+# Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others’ private information, such as a physical or email address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement Responsibilities
+
+Project maintainers are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+All project maintainers are obligated to respect the privacy and security of the reporter of any incident.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1,
+available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: https://www.contributor-covenant.org/version/2/1
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..a5703a4
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,94 @@
+# Contributing to Node Module Starter 🛠️
+
+We’re excited that you’re interested in contributing to Node Module Starter! This guide will help you get started.
+
+## How to Contribute
+
+### 1. Report Issues
+
+If you find a bug, have a question, or want to suggest a new feature:
+
+- Search Existing Issues: Check the [Issues](https://github.com/alessiofrittoli/node-module-starter/issues) tab to see if your concern has already been addressed.
+- Create a New Issue: If not, open a new issue. Please provide:
+ - A clear and descriptive title.
+ - Detailed steps to reproduce the issue (if applicable).
+ - Suggestions or ideas (if applicable).
+
+### 2. Fork the Repository
+
+Please, take a look at [Contributing to a project - GitHub Docs](https://docs.github.com/en/get-started/exploring-projects-on-github/contributing-to-a-project) page for more in-detail informations.
+
+- Go to the [repository page](https://github.com/alessiofrittoli/node-module-starter).
+- Click the Fork button.
+- Clone your fork to your local machine:
+
+```bash
+git clone https://github.com/your-username/node-module-starter.git
+```
+
+### 3. Create a Branch
+
+To make changes:
+
+- Navigate to your cloned repository:
+
+```bash
+cd node-module-starter
+```
+
+- Create and switch to a new branch:
+
+```bash
+git checkout -b feature/your-feature-name
+# or
+git checkout -b fix/your-fix-name
+# or
+git checkout -b doc/your-doc-improvements
+```
+
+### 4. Make Changes
+
+Keep changes relevant to your branch’s purpose.
+
+### 5. Commit Changes
+
+This repository requires signed commit, so please before continuing, take a look at [Signing Commits - GitHub Docs](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits).
+
+- Stage your changes:
+
+```bash
+git add .
+```
+
+- Write a meaningful commit message:
+
+```bash
+git commit -m "Add feature/bug-fix description"
+```
+
+### 6. Push to Your Fork
+
+Push your branch to your forked repository:
+
+```bash
+git push origin feature/your-feature-name
+```
+
+### 7. Submit a Pull Request
+
+- Navigate to your forked repository on GitHub.
+- Click the Pull Request button.
+- Select the base repository and compare across forks.
+- Add a detailed description explaining your changes.
+
+## Code of Conduct
+
+By participating in this project, you agree to follow our [Code of Conduct](./CODE_OF_CONDUCT.md).
+
+## Review Process
+
+Pull requests will be reviewed by maintainers.
+Feedback may be provided; be prepared to make changes if requested.
+Once approved, your contribution will be merged into the main branch.
+
+Thank you for helping improve Node Module Starter! 🎉
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5342037
--- /dev/null
+++ b/README.md
@@ -0,0 +1,168 @@
+# Node Module Starter 🛠️
+
+[![NPM Latest Version][version-badge]][npm-url] [![Coverage Status][coverage-badge]][coverage-url] [![NPM Monthly Downloads][downloads-badge]][npm-url] [![Dependencies][deps-badge]][deps-url]
+
+[version-badge]: https://img.shields.io/npm/v/%40alessiofrittoli%2Fnode-module-starter
+[npm-url]: https://npmjs.org/package/%40alessiofrittoli%2Fnode-module-starter
+[coverage-badge]: https://coveralls.io/repos/github/alessiofrittoli/node-module-starter/badge.svg
+[coverage-url]: https://coveralls.io/github/alessiofrittoli/node-module-starter
+[downloads-badge]: https://img.shields.io/npm/dm/%40alessiofrittoli%2Fnode-module-starter.svg
+[deps-badge]: https://img.shields.io/librariesio/release/npm/%40alessiofrittoli%2Fnode-module-starter
+[deps-url]: https://libraries.io/npm/%40alessiofrittoli%2Fnode-module-starter
+
+## Starter repository for developing node_modules
+
+### Table of Contents
+
+- [Getting started](#getting-started)
+- [Development](#development)
+ - [ESLint](#eslint)
+ - [Jest](#jest)
+- [Contributing](#contributing)
+- [Security](#security)
+- [Credits](#made-with-)
+
+---
+
+### Getting started (delete once cloned in your project)
+
+Run the following command to start using `node-module-starter` for your projects:
+
+```bash
+git clone git@github.com:alessiofrittoli/node-module-starter.git && git remote remove origin
+```
+
+install dependencies
+
+```bash
+pnpm i
+```
+
+Read the [Creating a repository from a template - GitHub Docs](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template) for more in-detail informations about creating a new Repository from a template using GitHub web interface.
+
+---
+
+### Getting started (customize based on your project needs)
+
+Run the following command to start using `{package_name}` in your projects:
+
+```bash
+npm i {package_name}
+```
+
+or using `pnpm`
+
+```bash
+pnpm i {package_name}
+```
+
+---
+
+### Development
+
+#### Install depenendencies
+
+```bash
+npm install
+```
+
+or using `pnpm`
+
+```bash
+pnpm i
+```
+
+#### Build the source code
+
+Run the following command to test and build code for distribution.
+
+```bash
+pnpm build
+```
+
+#### [ESLint](https://www.npmjs.com/package/eslint)
+
+warnings / errors check.
+
+```bash
+pnpm lint
+```
+
+#### [Jest](https://npmjs.com/package/jest)
+
+Run all the defined test suites by running the following:
+
+```bash
+# Run tests and watch file changes.
+pnpm test:watch
+
+# Run tests and watch file changes with jest-environment-jsdom.
+pnpm test:jsdom
+
+# Run tests in a CI environment.
+pnpm test:ci
+
+# Run tests in a CI environment with jest-environment-jsdom.
+pnpm test:ci:jsdom
+```
+
+You can eventually run specific suits like so:
+
+```bash
+pnpm test:jest
+pnpm test:jest:jsdom
+```
+
+Run tests with coverage.
+
+An HTTP server is then started to serve coverage files from `./coverage` folder.
+
+⚠️ You may see a blank page the first time you run this command. Simply refresh the browser to see the updates.
+
+```bash
+test:coverage:serve
+```
+
+---
+
+### Contributing
+
+Contributions are truly welcome!\
+Please refer to the [Contributing Doc](./CONTRIBUTING.md) for more information on how to start contributing to this project.
+
+---
+
+### Security
+
+If you believe you have found a security vulnerability, we encourage you to **_responsibly disclose this and NOT open a public issue_**. We will investigate all legitimate reports. Email `security@alessiofrittoli.it` to disclose any security vulnerabilities.
+
+### Made with ☕
+
+
+