mirror of
https://github.com/SomboChea/ui
synced 2024-11-24 15:04:27 +07:00
6b5d0b7e2e
This PR convert the code base to Typescript, the changes are the following: - migrate code base to Typescript (3.4.x) - enable `eslint` and `@typescript-eslint/eslint-plugin` (warnings still need to be addressed in future pull request - update relevant dependencies for this PR (linting, etc) - enable `bundlezise` (it was disabled for some reason) * refactor: refactoring to typescript * refactor: migrating to typescript * refactor: applied feedbacks * fix: fixed conflicts * refactored: changed registry * refactor: updated registry & removed unnecessary lib * fix: fixed registry ur * fix: fixed page load * refactor: refactored footer wip * refactor: converting to ts..wip * refactor: converting to ts. wip * refactor: converting to ts. wip * refactor: converting to ts * refactor: converting to ts * fix: fixed load errors * refactor: converted files to ts * refactor: removed flow from tests * fix: removed transpiled files * refactor: added ts-ignore * fix: fixed errors * fix: fixed types * fix: fixing jest import -.- * fix: fixing lint errors * fix: fixing lint errors * fix: fixed lint errors * refactor: removed unnecessary tsconfig's config * fix: fixing errors * fix: fixed warning * fix: fixed test * refactor: wip * refactor: wip * refactor: wip * fix: fixing tests: wip * wip * wip * fix: fixed search test * wip * fix: fixing lint errors * fix: re-added stylelint * refactor: updated stylelint script * fix: fixed: 'styles.js' were found. * fix: fixed Search tests * chore: enable eslint eslint needs expecitely to know which file has to lint, by default is JS, in this case we need also ts,tsx files eslint . --ext .js,.ts * chore: vcode eslint settings * chore: restore eslint previous conf * chore: clean jest config * chore: fix eslint warnings * chore: eslint errors cleared chore: clean warnings chore: remove github actions test phases chore: remove dupe rule * chore: update handler name * chore: restore logo from img to url css prop - loading images with css is more performant than using img html tags, switching this might be a breaking change - restore no-empty-source seems the linting do not accept false - update snapshots - remove @material-ui/styles * chore: update stylelint linting * chore: update stylelint linting * chore: fix a mistake on move tabs to a function * chore: eanble bundlezie * chore: use default_executor in circleci * chore: update readme
89 lines
5.0 KiB
Markdown
Executable File
89 lines
5.0 KiB
Markdown
Executable File
|
|
|
|
|
|
# Version 4 UI Theme
|
|
|
|
[Verdaccio](https://verdaccio.org/) UI is a [theme plugin](https://verdaccio.org/docs/en/dev-plugins#theme-plugin) build in React, Flow and Emotion. It uses Jest and Enzyme for Unit testing.
|
|
|
|
|
|
[](https://www.npmjs.com/package/@verdaccio/ui-theme)
|
|
[](https://verdaccio.org/docs/en/docker.html)
|
|
[](https://opencollective.com/verdaccio)
|
|
[](https://stackshare.io/verdaccio)
|
|
[](http://chat.verdaccio.org/)
|
|
[](https://www.npmjs.com/package/@verdaccio/ui-theme)
|
|
|
|
[](https://crowdin.com/project/verdaccio)
|
|
[](https://codecov.io/gh/verdaccio/ui)
|
|
|
|
|
|
[](https://twitter.com/verdaccio_npm)
|
|
[](https://github.com/verdaccio/verdaccio/stargazers)
|
|
|
|
## Contributing
|
|
|
|
We use `>=yarn@1.13.0`, keep on mind we use lock file.
|
|
|
|
For development run the following command, it will execute `webpack` and `verdaccio` to
|
|
|
|
```
|
|
yarn dev
|
|
```
|
|
The configuration file is located on `tools/_config.yaml`.
|
|
|
|
Run linting tooling and test to check your code is clean before commit.
|
|
|
|
```
|
|
yarn lint && yarn test
|
|
```
|
|
|
|
Remember we follow the [the Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0-beta.4/).
|
|
|
|
🤓 Feel free to participate in code reviews, let us know if you want to participate in this plugin.
|
|
|
|
|
|
## Open Collective Sponsors
|
|
|
|
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/verdaccio#sponsor)]
|
|
|
|
[](https://opencollective.com/verdaccio/sponsor/0/website)
|
|
[](https://opencollective.com/verdaccio/sponsor/1/website)
|
|
[](https://opencollective.com/verdaccio/sponsor/2/website)
|
|
[](https://opencollective.com/verdaccio/sponsor/3/website)
|
|
[](https://opencollective.com/verdaccio/sponsor/4/website)
|
|
[](https://opencollective.com/verdaccio/sponsor/5/website)
|
|
[](https://opencollective.com/verdaccio/sponsor/6/website)
|
|
[](https://opencollective.com/verdaccio/sponsor/7/website)
|
|
[](https://opencollective.com/verdaccio/sponsor/8/website)
|
|
[](https://opencollective.com/verdaccio/sponsor/9/website)
|
|
|
|
## Open Collective Backers
|
|
|
|
Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/verdaccio#backer)]
|
|
|
|
[](https://opencollective.com/verdaccio#backers)
|
|
|
|
## Contributors
|
|
|
|
This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
|
|
|
|
[](../../graphs/contributors)
|
|
|
|
### FAQ / Contact / Troubleshoot
|
|
|
|
If you have any issue you can try the following options, do no desist to ask or check our issues database, perhaps someone has asked already what you are looking for.
|
|
|
|
* [Blog](https://medium.com/verdaccio)
|
|
* [Donations](https://opencollective.com/verdaccio)
|
|
* [Roadmaps](https://github.com/verdaccio/verdaccio/projects)
|
|
* [Reporting an issue](https://github.com/verdaccio/verdaccio/blob/master/CONTRIBUTING.md#reporting-a-bug)
|
|
* [Running discussions](https://github.com/verdaccio/verdaccio/issues?q=is%3Aissue+is%3Aopen+label%3Adiscuss)
|
|
* [Chat](http://chat.verdaccio.org/)
|
|
* [Logos](https://verdaccio.org/docs/en/logo)
|
|
* [FAQ](https://github.com/verdaccio/verdaccio/issues?utf8=%E2%9C%93&q=is%3Aissue%20label%3Aquestion%20)
|
|
* [Docker Examples](https://github.com/verdaccio/docker-examples)
|
|
|
|
### License
|
|
|
|
Verdaccio is [MIT licensed](https://github.com/verdaccio/verdaccio/blob/master/LICENSE)
|