https://github.com/wezomcompany/typescript-lib-template

https://github.com/wezomcompany/typescript-lib-template

Last synced: 5 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/wezomcompany/typescript-lib-template
• Owner: WezomCompany
• License: bsd-3-clause
• Created: 2020-08-14T11:06:05.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2023-08-14T21:58:11.000Z (over 1 year ago)
• Last Synced: 2024-04-14T07:24:25.825Z (7 months ago)
• Language: JavaScript
• Size: 530 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# DISCLAIMER

> This template is a solution to specific needs that are relevant for us now.  

> It does not pretend to be a comprehensive use for all cases.

>

> The template uses what we consider to be the best libraries at the moment.

>

> The template may change in the future!  

> Use it at your own risk.

## Initialize this template

```sh

pnpm install

pnpm run init

```

After everything is done - commit the changes and push them to git.   

Then start developing your library.

#### Initialization process

1. Get all available static information about the current repository:

    - Git repository owner

    - Git repository name

    - Folder name

    - Current year for license

2. Run the interactive menu for clarification the collected information and

   for asking additional questions to obtain information that cannot be obtained

   from static code

    - Package name (default: folder name)

    - Package description (default: empty)

    - Package version (default: 0.0.0-alpha.0)

    - Package author (default: git user name)

    - Package author email (default: git user email)

    - Repository URL (default: git repository URL)

    - License owner (default: git user name)

3. Replace all text markers in the templates with the collected information

    - `/LICENSE`

    - `/package.json`

    - `/README.md`

4. Clean current README.md

    - Cut off all text before the line with the marker "CUT OFF HERE"

5. Delete the initialization sources

    - delete `/src/init` folder

    - delete unneeded dependencies from `package.json`

[comment]: <> (CUT_OFF_HERE)

# {#PACKAGE_NAME#}

[![NPM version badge](https://img.shields.io/npm/v/{#PACKAGE_NAME#}.svg)](https://www.npmjs.com/package/{#PACKAGE_NAME#})

[![NPM license badge](https://img.shields.io/npm/l/{#PACKAGE_NAME#}.svg)](https://www.npmjs.com/package/{#PACKAGE_NAME#})

[![CI Test and Build]({#REPO_URL#}/actions/workflows/ci.yml/badge.svg)]({#REPO_URL#}/actions/workflows/ci.yml)

> _{#PACKAGE_DESCRIPTION#}_

## Coverage

| Statements                  | Branches                | Functions                 | Lines             |

| --------------------------- | ----------------------- | ------------------------- | ----------------- |

| ![Statements](#statements#) | ![Branches](#branches#) | ![Functions](#functions#) | ![Lines](#lines#) |

---