Skip to content

Commit

Permalink
ci: add lint-staged
Browse files Browse the repository at this point in the history
  • Loading branch information
stas-nc committed Oct 21, 2024
1 parent 01d052f commit 3ebb7c9
Show file tree
Hide file tree
Showing 6 changed files with 12,492 additions and 5,913 deletions.
1 change: 1 addition & 0 deletions .husky/commit-msg
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
npx --no -- commitlint --edit $1
3 changes: 3 additions & 0 deletions .husky/pre-commit
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
npx lint-staged
npm run build
npm test
22 changes: 14 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# App development SDK for ILC

[![NPM package](https://badgen.net/npm/v/ilc-sdk?color=red&icon=npm&label=)](https://www.npmjs.com/package/ilc-sdk)
[![NPM downloads](https://badgen.net/npm/dt/ilc-sdk)](https://www.npmjs.com/package/ilc-sdk)

Expand All @@ -12,17 +13,22 @@ $ npm i ilc-sdk

## Documentation

* JS docs https://namecheap.github.io/ilc-sdk/
* Additional materials
* [ILC to App interface](https://namecheap.github.io/ilc-sdk/pages/Pages/ilc_app_interface.html)
* [ILC Global API](https://namecheap.github.io/ilc-sdk/pages/Pages/global_api.html)
* [Registry API](https://namecheap.github.io/ilc-sdk/pages/Pages/registry_api.html)
* [Public Path Problem](https://namecheap.github.io/ilc-sdk/pages/Pages/public_path.html)
- JS docs https://namecheap.github.io/ilc-sdk/
- Additional materials
- [ILC to App interface](https://namecheap.github.io/ilc-sdk/pages/Pages/ilc_app_interface.html)
- [ILC Global API](https://namecheap.github.io/ilc-sdk/pages/Pages/global_api.html)
- [Registry API](https://namecheap.github.io/ilc-sdk/pages/Pages/registry_api.html)
- [Public Path Problem](https://namecheap.github.io/ilc-sdk/pages/Pages/public_path.html)

## Node.js and App entrypoints

This package features 2 bundles that are intended to be used in Node.js app that runs SSR bundle of your app and
the application itself.

* Node.js server bundle - [documentation](https://namecheap.github.io/ilc-sdk/modules/server.html)
* Application bundle - [documentation](https://namecheap.github.io/ilc-sdk/modules/app.html)
- Node.js server bundle - [documentation](https://namecheap.github.io/ilc-sdk/modules/server.html)
- Application bundle - [documentation](https://namecheap.github.io/ilc-sdk/modules/app.html)

## Contribution

- Commit messages must follow the [conventional commits specification](https://www.conventionalcommits.org/en/v1.0.0/#specification)
- This library follows [semantic versioning](https://semver.org/)
4 changes: 4 additions & 0 deletions lint-staged.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
module.exports = {
'*': 'prettier --ignore-unknown --write',
'*.ts': 'npm run lint -- --fix',
};
Loading

0 comments on commit 3ebb7c9

Please sign in to comment.