Skip to content

Commit

Permalink
customized initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
softberry committed Mar 24, 2024
1 parent c3cea95 commit 0c07f56
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 75 deletions.
81 changes: 13 additions & 68 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,59 +1,4 @@
# typescript-npm-package-template

> Template to kickstart creating a Node.js module using TypeScript and VSCode
Inspired by [node-module-boilerplate](https://github.com/sindresorhus/node-module-boilerplate)

## Features

- [Semantic Release](https://github.com/semantic-release/semantic-release)
- [Issue Templates](https://github.com/ryansonshine/typescript-npm-package-template/tree/main/.github/ISSUE_TEMPLATE)
- [GitHub Actions](https://github.com/ryansonshine/typescript-npm-package-template/tree/main/.github/workflows)
- [Codecov](https://about.codecov.io/)
- [VSCode Launch Configurations](https://github.com/ryansonshine/typescript-npm-package-template/blob/main/.vscode/launch.json)
- [TypeScript](https://www.typescriptlang.org/)
- [Husky](https://github.com/typicode/husky)
- [Lint Staged](https://github.com/okonet/lint-staged)
- [Commitizen](https://github.com/search?q=commitizen)
- [Jest](https://jestjs.io/)
- [ESLint](https://eslint.org/)
- [Prettier](https://prettier.io/)

## Getting started

### Set up your repository

**Click the "Use this template" button.**

Alternatively, create a new directory and then run:

```bash
curl -fsSL https://github.com/ryansonshine/typescript-npm-package-template/archive/main.tar.gz | tar -xz --strip-components=1
```

Replace `FULL_NAME`, `GITHUB_USER`, and `REPO_NAME` in the script below with your own details to personalize your new package:

```bash
FULL_NAME="John Smith"
GITHUB_USER="johnsmith"
REPO_NAME="my-cool-package"
sed -i.mybak "s/\([\/\"]\)(ryansonshine)/$GITHUB_USER/g; s/typescript-npm-package-template\|my-package-name/$REPO_NAME/g; s/Ryan Sonshine/$FULL_NAME/g" package.json package-lock.json README.md
rm *.mybak
```

### Add NPM Token

Add your npm token to your GitHub repository secrets as `NPM_TOKEN`.

### Add Codecov integration

Enable the Codecov GitHub App [here](https://github.com/apps/codecov).

**Remove everything from here and above**

---

# my-package-name
# blurhash-map

[![npm package][npm-img]][npm-url]
[![Build Status][build-img]][build-url]
Expand All @@ -68,13 +13,13 @@ Enable the Codecov GitHub App [here](https://github.com/apps/codecov).
## Install

```bash
npm install my-package-name
npm install blurhash-map
```

## Usage

```ts
import { myPackage } from 'my-package-name';
import { myPackage } from 'blurhash-map';

myPackage('hello');
//=> 'hello from my package'
Expand All @@ -101,16 +46,16 @@ Default: `rainbows`

Lorem ipsum.

[build-img]:https://github.com/ryansonshine/typescript-npm-package-template/actions/workflows/release.yml/badge.svg
[build-url]:https://github.com/ryansonshine/typescript-npm-package-template/actions/workflows/release.yml
[downloads-img]:https://img.shields.io/npm/dt/typescript-npm-package-template
[downloads-url]:https://www.npmtrends.com/typescript-npm-package-template
[npm-img]:https://img.shields.io/npm/v/typescript-npm-package-template
[npm-url]:https://www.npmjs.com/package/typescript-npm-package-template
[issues-img]:https://img.shields.io/github/issues/ryansonshine/typescript-npm-package-template
[issues-url]:https://github.com/ryansonshine/typescript-npm-package-template/issues
[codecov-img]:https://codecov.io/gh/ryansonshine/typescript-npm-package-template/branch/main/graph/badge.svg
[codecov-url]:https://codecov.io/gh/ryansonshine/typescript-npm-package-template
[build-img]:https://github.com/ryansonshine/blurhash-map/actions/workflows/release.yml/badge.svg
[build-url]:https://github.com/ryansonshine/blurhash-map/actions/workflows/release.yml
[downloads-img]:https://img.shields.io/npm/dt/blurhash-map
[downloads-url]:https://www.npmtrends.com/blurhash-map
[npm-img]:https://img.shields.io/npm/v/blurhash-map
[npm-url]:https://www.npmjs.com/package/blurhash-map
[issues-img]:https://img.shields.io/github/issues/ryansonshine/blurhash-map
[issues-url]:https://github.com/ryansonshine/blurhash-map/issues
[codecov-img]:https://codecov.io/gh/ryansonshine/blurhash-map/branch/main/graph/badge.svg
[codecov-url]:https://codecov.io/gh/ryansonshine/blurhash-map
[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
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 5 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "typescript-npm-package-template",
"name": "blurhash-map",
"version": "0.0.0-development",
"description": "A template for creating npm packages using TypeScript and VSCode",
"main": "./lib/index.js",
Expand All @@ -19,11 +19,11 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/ryansonshine/typescript-npm-package-template.git"
"url": "git+https://github.com/ryansonshine/blurhash-map.git"
},
"license": "MIT",
"author": {
"name": "Ryan Sonshine",
"name": "Emre Sakarya",
"email": "ryansonshine@users.noreply.github.com",
"url": "https://github.com/ryansonshine"
},
Expand All @@ -42,9 +42,9 @@
"codecov"
],
"bugs": {
"url": "https://github.com/ryansonshine/typescript-npm-package-template/issues"
"url": "https://github.com/ryansonshine/blurhash-map/issues"
},
"homepage": "https://github.com/ryansonshine/typescript-npm-package-template#readme",
"homepage": "https://github.com/ryansonshine/blurhash-map#readme",
"devDependencies": {
"@ryansonshine/commitizen": "^4.2.8",
"@ryansonshine/cz-conventional-changelog": "^3.3.4",
Expand Down

0 comments on commit 0c07f56

Please sign in to comment.