Skip to content

Latest commit

 

History

History
109 lines (69 loc) · 3.36 KB

README.md

File metadata and controls

109 lines (69 loc) · 3.36 KB
Raw

What is tooling.report?

It's a quick way to determine the best build tool for your next web project, or if tooling migration is worth it, or how to adopt a tool's best practice into your existing configuration and code base.

To get set up

npm install

To dev

npm run dev

This starts the build in watch mode, and starts an HTTP server.

To build for production

npm run build

Project shape

  • lib - Various scripts and plugins for the build.
  • static-build - this script runs at the end of the build process and generates HTML.
  • client - All client-side JS goes here. It doesn't need to go here, but it keeps it separate from the static generation JS.
  • tests - Markdown for all the tests and results - see below.

Test structure

A test directory contains:

  • index.md - Describes the test or test category. Must include title in the front-matter.
  • Results for each tool in a folder (rollup, webpack, parcel, browserify - all optional) - Each folder contains an index.md describing how a particular build tool performs. If no results are present, this directory is considered to be a category only. Each result file requires result in the front-matter, which must be 'pass', 'fail' or 'partial'. The folder also contains a minimal project for the respective tool showing how to pass the current test. Build artifacts should be placed in a folder called build, as that folder is globally ignored.
  • If a test has subtests, the folder must be named subtests and contain the structure above.

Special imports

Client bundles

import bundleURL, { imports } from 'client-bundle:client/home/index.ts';

client-bundle: followed by a path to script will bundle and minify that script as an entry point. If two entry points share a module, it'll be code-split.

  • bundleURL - URL of the bundled script.
  • imports - URLs of scripts imported by this script (eg for preloading).

This style of import can only be used in static-build.

CSS modules

import { $tabButton, $promo, $feature } from './styles.css';

Imports ending .css are assumed to be CSS modules. All exports are derived from classnames in the CSS. So, if the CSS contains .tab-button, then $tabButton will be one of the exports.

CSS bundles

import cssURL, { inline } from 'css-bundle:./styles.css';

The CSS supports CSS modules, Sass-style nesting, imports will be inlined, and the output will be minified.

  • cssURL - URL to the CSS resource.
  • inline - The text of the CSS.

Markdown

import { html, meta } from 'md:./whatever.md';

md: followed by a path to some markdown will give you the following:

  • html - The markdown as HTML.
  • meta - Metadata from the markdown (Front Matter).

Other assets

import assetURL from 'asset-url:./foo.png';

asset-url: followed by a path to a file will add that file to the build.

  • assetURL - URL to the asset.

Constants

import isProduction from 'consts:isProduction';

If you want to add a constant value, add it to the object passed to constsPlugin in rollup.config.js. You'll also need to add an entry for it in missing-types.d.ts.

Test data

import tests from 'test-data:';

This returns an object representation of everything in the tests directory. See static-build/missing-types.d.ts for the structure of this object.