Skip to content

Latest commit

 

History

History
141 lines (102 loc) · 6.29 KB

README.md

File metadata and controls

141 lines (102 loc) · 6.29 KB
Raw
author date keywords
Sebastian Pieczynski
2018.12.20
react, typescript, babel, webpack, jest, eslint, jest-eslint-runner, jest-runner-tsc

🌱 TL;DR

Not ready for production / Alpha version, use at your own risk. / There might be bugs here.

This setup tries to achieve Typescript compatibility with React development while retaining all functionality of standard JS tools like ESlint, Babel and Webpack - no use of ts-lint, ts-loaders or ts-jest (although that one might be beneficial to use).

It is basically like Create React App after ejecting but with configuration I as a beginner could understand. Also I wanted to see how hard would a proper setup be... it is difficult.

End to end tests in dev mode are monitored and static server is rebooted every time files in .\src are changed. This does not with webpack dev server so serve is used so nodemon reloads every time to make end-to-end testing easier and faster.

PRs are very welcome.

🌙 installation

Clone this repository and run yarn install. All dependencies are local to this environment except for Typescript that you must install globally.

If you don't want to use pre-commit hooks for git, just clear the "pre-commit" command in package.json.

💝 why?

I love good tools and love building them. I also wanted to learn React/JS/Testing properly so I decided to get all the best tools available for JS/React etc. and combine them into a coherent package. This proved to be more difficult and exciting than it looked like. I was inspired by Kent C. Dodds to use TypeScript for type checking only and have all other tools from pure JS ecosystem. It started with videos about Jest runners and then I "overengineered" the starter package.

🏁 goal

Typescript used only for type checking, React development with Jest and Cypress as testing environment. All transpiled by Babel 7 and packaged with Webpack 4. ESLint/Stylelint for static code linting. Prettier for code style and some quality of life packages.

🍃 the stack

🔋 what works

  • Typescript,
  • Jest,
  • Jest runners:
    • ESLint,
    • StyleLint (css, scss) with Prettier compatibility,
    • Type Checking via TSC,
    • Tests,
  • Prettier rules,
  • Eslint,
  • Stylelint,
  • React,
  • Babel,
  • Babel polyfills based on usage,
  • Webpack,
  • Web Dev Server.
  • HMR.
  • React Testing Library.
  • SCSS (and other non-js files) module import in tests.
  • Git precommit hooks running tests.

🔩 what is not tested yet

  • Emotion.

🔧 Must be done before tagging 1.0

  • Cleanup regexp rules for consistency.
  • Check ESLint rules.
  • Check Prettier rules.
  • Add Jest Prettier runner.
  • Add comments to options so it is clear why they must be setup as they are.
  • Create documentation for the setup.

💸 TODO

  • Add Documentation links for all used packages so configuration changes are easier.
  • See if it makes sense to run e2e dev server with webpack dev server (it hangs currently) instead of current workaround.

📚 Future Plans

  • webpack - it can be optimized or improved
    • production build.
  • Service worker for offline usage.
  • Example app using all of the above.
  • Material UI 4 (Start of Q2 2019)
  • Create example React application with hooks and testing best practices (Start of Q2 2019)
  • GraphQL? (Apollo/Prisma?).

🐛 Known Bugs

Tests fail with TypeError: Cannot read property 'some' of undefined

The error when running tests that says:

TypeError: Cannot read property 'some' of undefined when tunning a test project and that points to babel at rewriteModuleStatementsAndPrepareHeader (node_modules/@babel/helper-module-transforms/lib/index.js:115:44) happens only when using --runInBand with --no-cache combination.

If your tests are failing please remove either of these flags. Your tests will pass. This was a bug in Jest < 24. See: jestjs/jest#7762

Cypress and Chrome Enterprise

Runnning Cypress with Chrome Enterprise version that has settings locked (at this moment I do not know which) can make code like this:

describe("Smoke ping Homepage", function() {
  it("Visits the Home Page", function() {
    cy.visit("http://localhost:8080");
    cy.get("h1");
  });
});

Show only HTML page without any resources/js files loaded.

At this moment a workaround is in place and Cypress is configured to use built-in Electron browser to run the tests.

👏 Thank you ❗

At some point in this journey I stumbled upon these articles and they did help clarify one thing or another or were source of inspiration:

Post configuration links: