https://github.com/phucbm/npm-utils-template
https://github.com/phucbm/npm-utils-template
Last synced: 12 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/phucbm/npm-utils-template
- Owner: phucbm
- License: mit
- Created: 2025-07-01T02:56:17.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-08-01T23:20:57.000Z (12 months ago)
- Last Synced: 2025-08-02T04:34:32.725Z (12 months ago)
- Language: TypeScript
- Size: 119 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# PROJECT_NAME
A TypeScript utility package
[](https://www.npmjs.com/package/PACKAGE_NAME)
[](https://www.npmjs.com/package/PACKAGE_NAME)
[](https://www.npmjs.com/package/PACKAGE_NAME)
[](https://github.com/USERNAME/PROJECT_NAME/)
[](https://github.com/USERNAME/PROJECT_NAME/blob/main/LICENSE)
## 🚀 Quick Start
### Use this template with gen-from (recommended)
```bash
# Generate from this template
npx gen-from npm-utils-template
# Or use interactive mode
npx gen-from
# Generate in current directory
npx gen-from npm-utils-template --here
```
### Or use GitHub's "Use this template" button
Click the green "Use this template" button on the [GitHub repository page](https://github.com/USERNAME/PROJECT_NAME).
## Installation
```bash
npm i PACKAGE_NAME
```
```bash
pnpm add PACKAGE_NAME
```
## Usage
```typescript
import {myUtilityFunction} from 'PACKAGE_NAME'
// or
import myUtilityFunction from 'PACKAGE_NAME'
// Basic usage
const result = myUtilityFunction('your input');
```
## API
### `myUtilityFunction(input?: any): any`
Main utility function that processes the input.
**Parameters:**
- `input` (optional) - The input to process
**Returns:**
- The processed result
### `processElement(element: HTMLElement): HTMLElement`
Function for DOM element processing.
**Parameters:**
- `element` - HTML element to process
**Returns:**
- The processed element
## Development
```bash
# Install dependencies
pnpm install
# Run tests
pnpm test
# Build the package
pnpm run build
# Run tests in watch mode
pnpm run test:watch
```
## Automated Workflows
```
┌─────────────┐ ┌─────────────┐ ┌─────────────┐ ┌─────────────┐
│ DEPENDABOT │───▶│ TEST │───▶│ RELEASE │───▶│ PUBLISH │
└─────────────┘ └─────────────┘ └─────────────┘ └─────────────┘
```
This repository uses automated dependency management and publishing:
- **📦 Dependabot** - Creates PRs for dependency updates (daily for npm, weekly for actions)
- **🧪 Test PR Action** - Auto-tests and merges passing Dependabot PRs with comment feedback
- **🚀 Dependabot Release Action** - Creates releases with patch version bumps when dependencies merge
- **📤 Publish NPM Action** - Builds and publishes to npm registry when releases are created
## License
MIT © [USERNAME](https://github.com/USERNAME)