You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jan 2, 2022. It is now read-only.
A [Netlify plugin](https://www.netlify.com/build/plugins-beta/).
8
8
9
-
## Prequisites
9
+
## Usage
10
+
11
+
This is a Netlify plugin, which will run during your Netlify builds.
12
+
As of now, Netlify plugins are in closed beta.
13
+
You can learn more about them, and apply for the beta [here](https://www.netlify.com/build/plugins-beta/).
14
+
15
+
## Contributing
16
+
17
+
### Prequisites
10
18
11
19
This project uses [Node.js](https://nodejs.org) 12 to run.
12
20
@@ -18,12 +26,12 @@ yarn install
18
26
# or `pnpm install`
19
27
```
20
28
21
-
## Building
29
+
###Building
22
30
23
31
Run the `build` script to compile the TypeScript into the `tsc_output` folder.
24
32
This will compile the `src` and the `test` directory, so be careful not to upload the whole folder as a published package.
25
33
26
-
## Style
34
+
###Style
27
35
28
36
This project uses [Prettier](https://prettier.io) and [XO](https://github.com/xojs/xo).
29
37
@@ -41,7 +49,7 @@ yarn run lint
41
49
42
50
Note that XO will also error if you have TypeScript errors, not just if your formatting is incorrect.
43
51
44
-
## Linting
52
+
###Linting
45
53
46
54
This project uses [XO](https://github.com/xojs/xo) (which uses [ESLint](https://eslint.org) and some plugins internally) to perform static analysis on the TypeScript.
47
55
It reports things like unused variables or not following code conventions.
@@ -51,17 +59,3 @@ yarn run lint
51
59
```
52
60
53
61
Note that XO will also error if you have incorrect formatting, not just if your TypeScript code has errors.
54
-
55
-
## Testing
56
-
57
-
Unit tests are in the `test` folder.
58
-
You can run the tests with the `test` script:
59
-
60
-
```sh
61
-
yarn run test
62
-
```
63
-
64
-
### Coverage
65
-
66
-
This will generate a `coverage` folder which has a breakdown of coverage of the project.
67
-
The CI will upload the coverage information to [CodeCov](https://codecov.io) which can be [viewed here](https://codecov.io/gh/pizzafox/netlify-cache-nextjs).
0 commit comments