Skip to content

Commit d4f9b82

Browse files
committed
Customize from template
1 parent 3272874 commit d4f9b82

File tree

13 files changed

+6452
-23711
lines changed

13 files changed

+6452
-23711
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 28 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 34 deletions
This file was deleted.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 0 additions & 42 deletions
This file was deleted.

.github/workflows/codeql-analysis.yml

Lines changed: 0 additions & 71 deletions
This file was deleted.

.github/workflows/pr.yml

Lines changed: 0 additions & 22 deletions
This file was deleted.

.github/workflows/release.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,5 +27,4 @@ jobs:
2727
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
2828
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
2929
run: npx semantic-release
30-
- name: Code Coverage
31-
run: npm run coverage
30+

.husky/prepare-commit-msg

Lines changed: 0 additions & 4 deletions
This file was deleted.

README.md

Lines changed: 6 additions & 100 deletions
Original file line numberDiff line numberDiff line change
@@ -1,117 +1,23 @@
1-
# typescript-npm-package-template
2-
3-
> Template to kickstart creating a Node.js module using TypeScript and VSCode
4-
5-
Inspired by [node-module-boilerplate](https://github.com/sindresorhus/node-module-boilerplate)
6-
7-
## Features
8-
9-
- [Semantic Release](https://github.com/semantic-release/semantic-release)
10-
- [Issue Templates](https://github.com/ryansonshine/typescript-npm-package-template/tree/main/.github/ISSUE_TEMPLATE)
11-
- [GitHub Actions](https://github.com/ryansonshine/typescript-npm-package-template/tree/main/.github/workflows)
12-
- [Codecov](https://about.codecov.io/)
13-
- [VSCode Launch Configurations](https://github.com/ryansonshine/typescript-npm-package-template/blob/main/.vscode/launch.json)
14-
- [TypeScript](https://www.typescriptlang.org/)
15-
- [Husky](https://github.com/typicode/husky)
16-
- [Lint Staged](https://github.com/okonet/lint-staged)
17-
- [Commitizen](https://github.com/search?q=commitizen)
18-
- [Jest](https://jestjs.io/)
19-
- [ESLint](https://eslint.org/)
20-
- [Prettier](https://prettier.io/)
21-
22-
## Getting started
23-
24-
### Set up your repository
25-
26-
**Click the "Use this template" button.**
27-
28-
Alternatively, create a new directory and then run:
29-
30-
```bash
31-
curl -fsSL https://github.com/ryansonshine/typescript-npm-package-template/archive/main.tar.gz | tar -xz --strip-components=1
32-
```
33-
34-
Replace `FULL_NAME`, `GITHUB_USER`, and `REPO_NAME` in the script below with your own details to personalize your new package:
35-
36-
```bash
37-
FULL_NAME="John Smith"
38-
GITHUB_USER="johnsmith"
39-
REPO_NAME="my-cool-package"
40-
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
41-
rm *.mybak
42-
```
43-
44-
### Add NPM Token
45-
46-
Add your npm token to your GitHub repository secrets as `NPM_TOKEN`.
47-
48-
### Add Codecov integration
49-
50-
Enable the Codecov GitHub App [here](https://github.com/apps/codecov).
51-
52-
**Remove everything from here and above**
53-
54-
---
55-
56-
# my-package-name
1+
# notion-pull
572

583
[![npm package][npm-img]][npm-url]
594
[![Build Status][build-img]][build-url]
60-
[![Downloads][downloads-img]][downloads-url]
61-
[![Issues][issues-img]][issues-url]
62-
[![Code Coverage][codecov-img]][codecov-url]
63-
[![Commitizen Friendly][commitizen-img]][commitizen-url]
64-
[![Semantic Release][semantic-release-img]][semantic-release-url]
65-
66-
> My awesome module
675

686
## Install
697

708
```bash
71-
npm install my-package-name
9+
npm install notion-pull
7210
```
7311

7412
## Usage
7513

7614
```ts
77-
import { myPackage } from 'my-package-name';
15+
import { notionPull } from 'notion-pull';
16+
17+
notionPull(process.env.MY_NOTION_TOKEN, "./docs","./static/notion_images");
7818

79-
myPackage('hello');
80-
//=> 'hello from my package'
8119
```
8220

8321
## API
8422

85-
### myPackage(input, options?)
86-
87-
#### input
88-
89-
Type: `string`
90-
91-
Lorem ipsum.
92-
93-
#### options
94-
95-
Type: `object`
96-
97-
##### postfix
98-
99-
Type: `string`
100-
Default: `rainbows`
101-
102-
Lorem ipsum.
103-
104-
[build-img]:https://github.com/ryansonshine/typescript-npm-package-template/actions/workflows/release.yml/badge.svg
105-
[build-url]:https://github.com/ryansonshine/typescript-npm-package-template/actions/workflows/release.yml
106-
[downloads-img]:https://img.shields.io/npm/dt/typescript-npm-package-template
107-
[downloads-url]:https://www.npmtrends.com/typescript-npm-package-template
108-
[npm-img]:https://img.shields.io/npm/v/typescript-npm-package-template
109-
[npm-url]:https://www.npmjs.com/package/typescript-npm-package-template
110-
[issues-img]:https://img.shields.io/github/issues/ryansonshine/typescript-npm-package-template
111-
[issues-url]:https://github.com/ryansonshine/typescript-npm-package-template/issues
112-
[codecov-img]:https://codecov.io/gh/ryansonshine/typescript-npm-package-template/branch/main/graph/badge.svg
113-
[codecov-url]:https://codecov.io/gh/ryansonshine/typescript-npm-package-template
114-
[semantic-release-img]:https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
115-
[semantic-release-url]:https://github.com/semantic-release/semantic-release
116-
[commitizen-img]:https://img.shields.io/badge/commitizen-friendly-brightgreen.svg
117-
[commitizen-url]:http://commitizen.github.io/cz-cli/
23+
### notionPull(token, docs-destination-path, image-destination-path)

jest.config.js

Lines changed: 0 additions & 15 deletions
This file was deleted.

0 commit comments

Comments
 (0)