@terminal-packages/fe-theme
v2.1.0
Published
![Test Action Status](https://github.com/Terminal-Systems/fe-utils/workflows/Tests/badge.svg) ![Publish Action Status](https://github.com/Terminal-Systems/fe-utils/workflows/Publish/badge.svg?branch=master)
Downloads
17
Readme
FE Base Package
Base Typescript boilerplate to build FE packages on top of it
Available commands
build
: buildsrc
directorybuild:cjs
: buildsrc
directory usingcjs
modulesbuild:esm
: buildsrc
directory usingesm
modulesstorybook
: run storybook on port9001
clean
: deletecore
folderlint
: runeslint
onsrc
folderlint:fix
: run eslint in fixing mode onsrc
foldertest
: run tests
Note that our build
directory is called core
, that way you can publish the package and using it package-name/core/SomeComponent
like material-ui
Get started
- Clone the repo:
git clone https://github.com/Terminal-Systems/fe-base-pkg.git <package-name>
- Go to the project folder and edit the
package.json
:name
: package name (use @org-name/pkg-name for orgs)version
: 1.0.0author
: list of authorsrepository.url
:git+https://github.com/<username>/<package-name>.git
bugs.url
:https://github.com/<username>/<package-name>/issues
homepage
:https://github.com/<username>/<package-name>#readme
- Change the git remote url (you must to create an empty github project first):
git remote rm origin git remote add origin <your-new-git-remote-url>
Download last base library updates
As a result of changed the remote url for the library you will not be able to fetch the last updates using git pull origin
, instead, you should use:
git remote add fe-base-pkg https://github.com/Terminal-Systems/fe-base-pkg.git
git checkout -b <some-temp-branch-name>/upgrade
git fetch fe-base-pkg
git merge fe-base-pkg/master
Build a non React based library
If you want to create a non React
based library, you should remove some dependencies that are not required. To do that, please remove the following libraries from package.json
devDependencies
and peerDependencies
:
@material-ui/core
prop-types
react
react-dom
@types/prop-types
@types/react
@types/react-dom
peerDependencies
If you need to use a package that should be provided by your host app, please adding it as a peerDependencie
to avoid library duplications on node_modules
.
Important Note: peerDependencies
are not installed by npm install
or yarn install
. So in order to install peerDependencies
on dev enviroment you can add your required package as a peerDependencies
and devDependencies
. Otherwise, you can use a package like install-peers-cli
Workflow
Our library workflow is pretty straightforward: use develop
branch to add any new feature and master
to publish on npmjs.com
Testing
This boilerplate is pre-configured with jest. You can run your tets with the command: npm test
. If you need to use some of the enzyme
render methods, please consider use the test-utils
provided by @material-ui/core/test-utils
:
createMount
createShallow
createRender
Notes
Before commit any change, husky is going to run eslint in fixing mode, run tests and try to build the project to avoid pushing commits that break something