Add eslint and prettier support

This commit is contained in:
Joseph Garrone 2020-05-27 22:02:44 +02:00
parent 95d413a2ce
commit 89f37d738b
20 changed files with 1971 additions and 170 deletions

View file

@ -5,57 +5,58 @@
<i>#{DESC}#</i>
<br>
<br>
<img src="https://github.com/#{USER_OR_ORG}#/#{REPO_NAME}#/workflows/ci/badge.svg">
<img src="https://github.com/garronej/#{REPO_NAME}#/workflows/ci/badge.svg?branch=develop">
<img src="https://img.shields.io/bundlephobia/minzip/#{REPO_NAME}#">
<img src="https://img.shields.io/npm/dw/#{REPO_NAME}#">
<img src="https://img.shields.io/npm/l/#{REPO_NAME}#">
</p>
<p align="center">
<a href="https://github.com/#{USER_OR_ORG}#/#{REPO_NAME}#">Home</a>
-
<a href="https://github.com/#{USER_OR_ORG}#/#{REPO_NAME}#">Documentation</a>
-
<a href="https://gitter.im/#{REPO_NAME}#/">Chat</a>
</p>
---
# Install / Import
```bash
> npm install --save #{REPO_NAME}#
$ npm install --save #{REPO_NAME}#
```
```typescript
import { myFunction, myObject } from '#{REPO_NAME}#';
import { myFunction, myObject } from "#{REPO_NAME}#";
```
Specific imports:
```typescript
import { myFunction } from '#{REPO_NAME}#/myFunction';
import { myObject } from '#{REPO_NAME}#/myObject';
import { myFunction } from "#{REPO_NAME}#/myFunction";
import { myObject } from "#{REPO_NAME}#/myObject";
```
## Import from HTML, with CDN
Import it via a bundle that creates a global ( wider browser support ):
Import it via a bundle that creates a global ( wider browser support ):
```html
<script src="//unpkg.com/#{REPO_NAME}#/bundle.min.js"></script>
<script>
const { myFunction, myObject } = #{REPO_NAME_NO_DASHES}#;
const { myFunction, myObject } = #{REPO_NAME_NO_DASHES}#;
</script>
```
Or import it as an ES module:
Or import it as an ES module:
```html
<script type="module">
import { myFunction, myObject } from '//unpkg.com/#{REPO_NAME}#/zz_esm/index.js';
import {
myFunction,
myObject,
} from "//unpkg.com/#{REPO_NAME}#/zz_esm/index.js";
</script>
```
*You can specify the version you wish to import:* [unpkg.com](https://unpkg.com)
_You can specify the version you wish to import:_ [unpkg.com](https://unpkg.com)
## Contribute
```bash