@mikechau/react-scripts-ts-sass

0.4.1 • Public • Published

react-scripts-ts-sass

This package is a fork from the vanilla react-scripts, in order to add custom support for Typescript and Sass.

This package includes scripts and configuration used by Create React App. Please refer to its documentation:

Support

  • [x] JS/ES6
  • [x] Typescript
  • [x] SASS
  • [x] Multiple Entry Points
  • [x] Automatic Browser Open disabled by default (CRA_OPEN_BROWSER=true to reenable)

JS/ES6 support has been kept in, so you can use JS/ES6 and Typescript in the same project if you need to.

Usage

By default, you should have a src/index.js or src/index.tsx entry point. This will create the primary app bundle.

Multiple Entry Points

Your application src directory should contain a index.js or index.tsx file.

Alternatively, if you are building a an application with multiple entry points, you can create additional entry points by appending index before the filename extension.

When a filename following the convention of src/*.index.(ts|tsx|js|jsx) is detected, a new entry point will be added to the webpack entrypoint config.

A new html file will also be automatically generated, and default to using the public/index.html template if you did not create a custom template inside public.

To use a custom index.html, you can create a new html file with the matching entry point key.

Example:

src/index.tsx -> public/index.html
src/alt.index.tsx -> public/alt.html

The filetypes support for entry points are:

  • tsx
  • ts
  • js
  • jsx

NOTE: Periods after the first one will be ignored. If you want to generate additional index files for bundles named like one.two.three.index.js, it will be ignored and treated like one.index.js and generate a one.html. Use dashes or underscores as an alternative (ie. one-two-three.index.js -> one-two-three.html).

References

Readme

Keywords

none

Package Sidebar

Install

npm i @mikechau/react-scripts-ts-sass

Weekly Downloads

0

Version

0.4.1

License

BSD-3-Clause

Last publish

Collaborators

  • mikechau