Skip to content

Latest commit

 

History

History
47 lines (32 loc) · 2.59 KB

development-docs.md

File metadata and controls

47 lines (32 loc) · 2.59 KB

DEVELOPMENT

During development there are 3 pages you might be interested in.

  • The root page is there to display the documentation.
  • The /demo page is there to display various demos for how to use your component.
  • The /implementation page, is a sandbox where you can work with less noise compared to the demo page.

Running Your Project

  • npm start is the default command to spin your project. It will clean up any old builds and then start up a development server on port 3000 using Browsersync to reload the page when changes occur.

note: If you are finding that when reloading it is switching from demos back to docs, then in the browser add the route /demo to the url and then the refreshes will happen on that route.

Demos and Releases

All components should follow semver versioning.

  • You can run one of three commands to bump and tag your new release.

    • npm run release-patch updates from 0.0.1 to 0.0.2
    • npm run release-minor updates from 0.0.1 to 0.1.0
    • npm run release-major updates from 0.0.1 to 1.0.0

  • All projects also come with built in demos and docs.

    • npm run pages is the command to deploy a Github Pages site for your project
    • note:
      • This creates a orphan branch with no history.
      • Always run this from master after pulling the latest build to ensure your docs reflect the most recent version.

Linting

  • You need to install the eslint-cli globally before linting will work.
  • the configuration is in the .eslintrc.json file.
  • You can manually run eslint filename in your terminal to lint any file you want.
  • but there are also some predefined commands.
  • there are 2 linting commands
    • first a no-block-es-lint command that forces a clean exit despite there being linting errors, it is not the best plan, but it was solution found here.
    • second a full-lint command that runs the no-block-es-lint command and polymer lint in sequence. This is the command you should be running regularly.

Testing

Automated testing is also supported with TravisCI. If you enable this feature on the Github repo then tests are set to run on every commit. This can be adjusted in the .travis.yml