Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ezavile/postcss-typescript-kickstart

Simple boilerplate to kick start your new PostCSS plugin with TypeScript
https://github.com/ezavile/postcss-typescript-kickstart

boilerplate kickstart postcss postcss-plugin typescript

Last synced: 8 days ago
JSON representation

Simple boilerplate to kick start your new PostCSS plugin with TypeScript

Host: GitHub
URL: https://github.com/ezavile/postcss-typescript-kickstart
Owner: ezavile
License: mit
Created: 2017-05-23T04:32:36.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2017-05-23T16:51:14.000Z (over 7 years ago)
Last Synced: 2024-10-30T12:07:08.924Z (16 days ago)
Topics: boilerplate, kickstart, postcss, postcss-plugin, typescript
Language: TypeScript
Size: 37.1 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# postcss-typescript-kickstart

[![Travis](https://img.shields.io/travis/ezavile/postcss-typescript-kickstart.svg?style=flat-square)](https://travis-ci.org/ezavile/postcss-typescript-kickstart)
[![Codecov](https://img.shields.io/codecov/c/github/ezavile/postcss-typescript-kickstart.svg?style=flat-square)](https://codecov.io/gh/ezavile/postcss-typescript-kickstart)
[![npm](https://img.shields.io/npm/v/postcss-typescript-kickstart.svg?style=flat-square)](https://www.npmjs.com/package/postcss-typescript-kickstart)
[![MIT License](https://img.shields.io/npm/l/postcss-typescript-kickstart.svg?style=flat-square)](http://opensource.org/licenses/MIT)

Simple boilerplate to kickstart your new PostCSS plugin with TypeScript, also include AVA to test and generate a code coverage report.

## Usage

Clone the boilerplate and create your own git repo.

```javascript
git clone [email protected]:ezavile/postcss-typescript-kickstart.git
```

Install the dependencies.

```javascript
npm/yarn install
```

## Scripts

To compile TypeScript files.
```javascript
npm run compile
```

To compile TypeScript files and watch for changes.
```javascript
npm run compile:watch
```

Lint the source, then run the unit tests.
```javascript
npm test
```

Continuously run the unit tests as you make changes to the source and test files themselves.
```javascript
npm run test:watch
```

Lint the source.
```javascript
npm run lint
```

Generate a code coverage report. Anything less than 100% coverage will throw an error.
```javascript
npm run report-coverage
```

## Thanks
Inspired by [postcss-font-pack] to create the structure of the project.

## Contributing
* ⇄ Pull requests and ★ Stars are always welcome.
* For bugs and feature requests, please create an issue.
* Pull requests must be accompanied by passing automated tests (`npm test`).

[MIT License]

[postcss-font-pack]: https://github.com/jedmao/postcss-font-pack
[MIT License]: https://github.com/ezavile/postcss-typescript-css/blob/master/LICENSE