s-formatters v1.0.0

s-formatters

Template to kickstart creating a Node.js module using TypeScript and VSCode

Inspired by node-module-boilerplate

Features

• Semantic Release
• Issue Templates
• GitHub Actions
• Codecov
• VSCode Launch Configurations
• TypeScript
• Husky
• Lint Staged
• Commitizen
• Jest
• ESLint
• Prettier

Getting started

Set up your repository

Replace FULL_NAME, GITHUB_USER, NODE_VERSION and REPO_NAME in the ./customize.sh script with your own details to personalize your new package:

FULL_NAME="John Smith"
GITHUB_USER="johnsmith"
REPO_NAME="my-cool-package"
NODE_VERSION="18.17.1"

Add permission to edit chmod +x ./customize.sh and rund it ./customize.sh

Add Tokens for NPM(Automation), Github, CodeCov

Add your npm token to your GitHub repository secrets as NPM_TOKEN, GH_TOKEN and CODECOV_TOKEN

Add Codecov integration

Enable the Codecov GitHub App here.

Remove everything from here and above

s-formatters

My awesome module

Install

npm install s-formatters

Usage

import { myPackage } from 's-formatters';

myPackage('hello');
//=> 'hello from my package'

API

myPackage(input, options?)

input

Type: string

Lorem ipsum.

options

Type: object

postfix

Type: string Default: rainbows

Lorem ipsum.