Skip to content
A JavaScript bundle optimizer.
JavaScript Other
Branch: master
Clone or download
zertosh and facebook-github-bot Text lint all .gitignore files
Reviewed By: scottrice, pallotron

Differential Revision: D15353820

fbshipit-source-id: 74f9eaadc90363a958692259f5cb66cef91ac8ef
Latest commit 98d33f9 May 15, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Re-land typed descriptors and printer (#2511) Aug 31, 2018
assets Adding raw Prepack Logo assets (#2189) Jul 3, 2018
bin Cleanup files Dec 12, 2017
fb-www Make React tests fast (#2187) Jul 2, 2018
flow-libs Set up adapter communication channel with Prepack Oct 27, 2017
flow-typed/npm Remove flow-bin dep and pin flowconfig version to 0.83.0 Mar 22, 2019
fuzzer Fuzzer (#2374) Aug 9, 2018
scripts metro-buck: only uses object to store modules Dec 18, 2018
src Merge adjacent JOIN_GENERATORS with the same path conditions (#2623) Jan 29, 2019
test Merge adjacent JOIN_GENERATORS with the same path conditions (#2623) Jan 29, 2019
website Text lint all .gitignore files May 15, 2019
.eslintignore Upgrade Prepack to Babel 7 (#2256) Jul 14, 2018
.eslintrc Lint rule to prevent imports of modules from lib/* (#2604) Oct 17, 2018
.flowconfig Remove flow-bin dep and pin flowconfig version to 0.83.0 Mar 22, 2019
.gitignore Ignore project node_modules Aug 8, 2018
.gitmodules Initial commit Mar 29, 2017
.prettierrc Run Prettier checks on CI (#2212) Jul 10, 2018
.watchmanconfig Add React functional component folding Nov 6, 2017
CODE_OF_CONDUCT.md Updated the code of conduct links. (#2284) Jul 18, 2018
CONTRIBUTING.md Updated the code of conduct links. (#2284) Jul 18, 2018
LICENSE Initial commit Mar 29, 2017
PATENTS Initial commit Mar 29, 2017
README.md Update README to reflect current project status. Dec 27, 2018
babel.config.js Add serializer mode for test262 execution (#2290) Jul 19, 2018
package.json Upgrade prettier to 1.17.0 May 7, 2019
webpack.config.js Upgrade Prepack to Babel 7 (#2256) Jul 14, 2018
yarn.lock Upgrade prettier to 1.17.0 May 7, 2019

README.md

Prepack Circle CI

Prepack is a partial evaluator for JavaScript. Prepack rewrites a JavaScript bundle, resulting in JavaScript code that executes more efficiently. For initialization-heavy code, Prepack works best in an environment where JavaScript parsing is effectively cached.

See the official prepack.io website for an introduction and an interactive REPL playground.

Status

We, the Prepack team at Facebook, have temporarily set down work on Prepack including the React compiler project. You won't see many Prepack PRs while we are currently prioritizing some other projects. However, we'd like to resume work on Prepack again in a few months.

How to use Prepack

Install the CLI via npm,

$ npm install -g prepack

Or if you prefer yarn, make sure you get yarn first,

$ npm install -g yarn

and then install the Prepack CLI via yarn:

$ yarn global add prepack

You may need to prepend (pun intended!) the command with sudo in some cases.

Let the party begin

To compile a file and print the output to the console:

$ prepack script.js

If you want to compile a file and output to another file:

$ prepack script.js --out script-processed.js

Detailed instructions and the API can be found at Prepack CLI: Getting Started

Plugins to other tools

The following are a few plugins to other tools. They have been created and are maintained separately from Prepack itself. If you run into any issues with those plugins, please ask the plugin maintainers for support.

Test Results and Code Coverage

How to get the code

  1. Clone repository and make it your current directory.
  2. git submodule init
  3. git submodule update --init
  4. Get yarn and node, then do yarn

Note: For development work you really need yarn, as many scripts require it.

How to build, lint, type check

  1. Get the code
  2. yarn build
    You can later run yarn watch in the background to just compile changed files on the fly.
  3. yarn lint
  4. yarn flow

How to run tests

  1. Get the code
  2. Make sure the code is built, either by running yarn build or yarn watch
  3. yarn test

You can run individual test suites as follows:

  • yarn test-serializer
    This tests the interpreter and serializer. All tests should pass.
  • yarn test-test262
    This tests conformance against the test262 suite. Not all will pass, increasing conformance is work in progress.

How to run the interpreter

  1. Get the code
  2. Make sure the code is built, either by running yarn build or yarn watch
  3. yarn repl
    This starts an interactive interpreter session.

How to run Prepack

  1. Get the code

  2. Make sure the code is built, either by running yarn build or yarn watch.

  3. Have a JavaScript file handy that you want to prepack, for example:
    echo "function hello() { return 'hello'; } function world() { return 'world'; } s = hello() + ' ' + world();" >/tmp/sample.js

  4. cat /tmp/sample.js | yarn prepack-cli
    Try --help for more options.

How to validate changes

Instead of building, linting, type checking, testing separately, the following does everything together:
yarn validate

How to edit the website

The content for prepack.io resides in the website directory of this repository. To make changes, submit a pull request, just like for any code changes.

In order to run the website locally at localhost:8000:

  1. Build prepack into the website: yarn build && mv prepack.min.js website/js
  2. Run python -m SimpleHTTPServer (Python 2) or python -m http.server (Python 3) from the website/ directory

How to contribute

To read more about the project, check out this suggested reading wiki

For more information about contributing pull requests and issues, see our Contribution Guidelines.

License

Prepack is BSD-licensed. We also provide an additional patent grant.

You can’t perform that action at this time.