Điểm qua alexjoverm/typescript-library-starter: 4.4k sao trên GitHub, viết chủ yếu bằng TypeScript, thuộc nhóm Frontend. Starter kit with zero-config for building a library in TypeScript, featuring RollupJS, Jest, Prettier, TSLint, Semantic Release, and more!
Tóm tắt dựng từ metadata GitHub của chính dự án — chưa có bài review TopGit. Trang sẽ tự động cập nhật khi bài review đầy đủ được xuất bản.
VÌ SAO CHƯA CÓ REVIEW
TopGit viết bài đầy đủ cho repo có nhiều sao nhất và được yêu cầu nhiều nhất. Trang này là snapshot trong thời gian chờ — xem README gốc ở tab READ ME.
A starter project that makes creating a TypeScript library extremely easy.
Usage
git clone https://github.com/alexjoverm/typescript-library-starter.git YOURFOLDERNAME
cd YOURFOLDERNAME
# Run npm install and write your library name when asked. That's all!
npm install
Start coding!package.json and entry files are already set up for you, so don't worry about linking to your main file, typings, etc. Just keep those files with the same name.
Features
Zero-setup. After running npm install things will setup for you :wink:
RollupJS for multiple optimized bundles following the standard convention and Tree-shaking
Tests, coverage and interactive watch mode using Jest
Prettier and TSLint for code formatting and consistency
Docs automatic generation and deployment to gh-pages, using TypeDoc
Automatic types (*.d.ts) file generation
Travis integration and Coveralls report
(Optional) Automatic releases and changelog, using Semantic release, Commitizen, Conventional changelog and Husky (for the git hooks)
Importing library
You can import the generated bundle to use the whole library generated by this starter:
import myLib from 'mylib'
Additionally, you can import the transpiled modules from dist/lib in case you have a modular library:
import something from 'mylib/dist/lib/something'
NPM scripts
npm t: Run test suite
npm start: Run npm run build in watch mode
npm run test:watch: Run test suite in interactive watch mode
npm run test:prod: Run linting and generate coverage
npm run build: Generate bundles and typings, create docs
npm run lint: Lints code
npm run commit: Commit using conventional commit style (husky will tell you to use it if you haven't :wink:)
Excluding peerDependencies
On library development, one might want to set some peer dependencies, and thus remove those from the final bundle. You can see in Rollup docs how to do that.
Good news: the setup is here for you, you must only include the dependency name in external property within rollup.config.js. For example, if you want to exclude lodash, just write there external: ['lodash'].
Automatic releases
Prerequisites: you need to create/login accounts and add your project to:
npm
Travis CI
Coveralls
Prerequisite for Windows: Semantic-release uses
node-gyp so you will need to
install
Microsoft's windows-build-tools
using this command:
Follow the console instructions to install semantic release and run it (answer NO to "Do you want a .travis.yml file with semantic-release setup?").
Note: make sure you've setup repository.url in your package.json file
npm install -g semantic-release-cli
semantic-release-cli setup
# IMPORTANT!! Answer NO to "Do you want a `.travis.yml` file with semantic-release setup?" question. It is already prepared for you :P
From now on, you'll need to use npm run commit, which is a convenient way to create conventional commits.
Automatic releases are possible thanks to semantic release, which publishes your code automatically on github and npm, plus generates automatically a changelog. This setup is highly influenced by Kent C. Dodds course on egghead.io
Git Hooks
There is already set a precommit hook for formatting your code with Prettier :nail_care:
By default, there are two disabled git hooks. They're set up when you run the npm run semantic-release-prepare script. They make sure:
You follow a conventional commit message
Your build is not going to fail in Travis (or your CI server), since it's runned locally before git push
This makes more sense in combination with automatic releases
FAQ
Array.prototype.from, Promise, Map... is undefined?
TypeScript or Babel only provides down-emits on syntactical features (class, let, async/await...), but not on functional features (Array.prototype.find, Set, Promise...), . For that, you need Polyfills, such as core-js or babel-polyfill (which extends core-js).
For a library, core-js plays very nicely, since you can import just the polyfills you need:
alexjoverm/typescript-library-starter có bao nhiêu sao?
alexjoverm/typescript-library-starter có 4.4k sao GitHub — tải lại trang để xem số mới nhất, hoặc xem trực tiếp github.com/alexjoverm/typescript-library-starter. TopGit phản chiếu số sao của GitHub nhưng không cam kết đến từng phút.
alexjoverm/typescript-library-starter có những chủ đề gì?
GitHub topics của alexjoverm/typescript-library-starter: "coveralls", "jest", "library", "travis", "tslint", "typedoc", "typescript", "webpack". TopGit xếp repo vào nhóm Frontend.
alexjoverm/typescript-library-starter có website riêng không?
TopGit chưa ghi nhận URL trang chủ cho alexjoverm/typescript-library-starter. Phần README ở tab phía trên thường có link demo, hoặc xem mô tả GitHub của repo.
alexjoverm/typescript-library-starter còn đang phát triển không?
Commit gần nhất trên alexjoverm/typescript-library-starter là 4.6 năm trước (theo timestamp GitHub). Repo có 475 fork — một chỉ báo về mức độ quan tâm của cộng đồng.
alexjoverm/typescript-library-starter dùng license gì?
alexjoverm/typescript-library-starter phát hành theo license MIT. Nên mở file LICENSE trên GitHub để xác nhận — license metadata đôi khi lệch với thực tế dự án.
alexjoverm/typescript-library-starter viết bằng ngôn ngữ gì?
alexjoverm/typescript-library-starter chủ yếu viết bằng TypeScript. Trường "language" của GitHub dựa trên phần lớn byte ở nhánh mặc định.
Đọc thêm về alexjoverm/typescript-library-starter ở đâu?
Trang TopGit này là một snapshot — tab "Readme" hiển thị nguyên văn README của repo (đã bỏ link, giữ ảnh). Repo GitHub ở github.com/alexjoverm/typescript-library-starter là nguồn chính thức.
Đọc đầy đủ README ở tab phía trên.
Vẫn đang phân vân về typescript-library-starter?
Một cú bấm sẽ gửi câu hỏi kèm trang này cho AI — xem AI nói gì về typescript-library-starter.