https://github.com/nsisodiya/my-ts-mathlib

Boilerplate for small JavaScript utility library (like lodash) with TypeScript and Microbundle
https://github.com/nsisodiya/my-ts-mathlib

Last synced: about 1 month ago
JSON representation

Boilerplate for small JavaScript utility library (like lodash) with TypeScript and Microbundle

• Host: GitHub
• URL: https://github.com/nsisodiya/my-ts-mathlib
• Owner: nsisodiya
• License: mit
• Created: 2020-04-29T08:24:19.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-05-11T17:10:00.000Z (over 3 years ago)
• Last Synced: 2024-11-09T01:41:57.721Z (2 months ago)
• Language: TypeScript
• Homepage:
• Size: 1.48 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# my-ts-mathlib

This is a boilerplate for small JavaScript utility library (like lodash) with typescript and microbundle.

example folder has various demo.

# Tasks

Src

- [x] Basic Code in src folder

Publish

- [x] publish over npm

- [x] Type definition should be included in the project dist.

- [x] src, example and other folder should not be part of npm package.

UMD

- [x] UMD build with browser with direct script tag is working.

Browser env with Parcel + TypeScript

- [x] import { calRectangleArea } from 'my-ts-mathlib' should work.

- [ ] import calRectangleArea from 'my-ts-mathlib/es/calRectangleArea' should work.

- [x] Vscode should show error if we send incorrect data to function.

- [x] npm run start should fail on providing incorrect type.

- [x] npm run build should fail on providing incorrect type.

- [ ] calCircleArea should not be included in bundle

Browser env with CRA + TypeScript

- [x] import { calRectangleArea } from 'my-ts-mathlib' should work.

- [ ] import calRectangleArea from 'my-ts-mathlib/es/calRectangleArea' should work.

- [x] Vscode should show error if we send incorrect data to function.

- [x] npm run start should fail on providing incorrect type.

- [x] npm run build should fail on providing incorrect type.

- [x] calCircleArea should not be included in bundle

ES Module

- [x] working demo for Script type="module"

- [x] import { calSquareArea } from './node_modules/my-ts-mathlib/dist/index.module.js'; should be working

- [ ] import calSquareArea from './node_modules/my-ts-mathlib/dist/es/calSquareArea.js'; should be working

CommonJS - Node

- [x] var { calRectangleArea } = require('my-ts-mathlib') should work

- [ ] var calRectangleArea = require('my-ts-mathlib/es/calRectangleArea') should work

Node - TypeScript

- [x] import { calRectangleArea } from 'my-ts-mathlib' should work.

- [ ] import calRectangleArea from 'my-ts-mathlib/es/calRectangleArea' should work.

- [x] Vscode should show error if we send incorrect data to function.

- [x] npm run start should fail on providing incorrect type.

CodeSandbox Demo

- [ ] use the package it in code-sandbox

CRA TypeScript App

- [ ] package should work in CRA TypeScript App

Test Cases

- [ ] 100% CodeCoverage

- [ ] CircleCI build should run test cases.

Pull Request

- [ ] When somebody generate pull request, pull request should show test results.

Documentation over gh-pages

- [ ] Auto generate documentation like lodash.