Skip to content

Latest commit

 

History

History
102 lines (70 loc) · 2.45 KB

HACKING.md

File metadata and controls

102 lines (70 loc) · 2.45 KB
Raw

Hacking

Setup/installation

Check out a copy of this repository and then install its dependencies:

yarn

Running the example/boilerplate

The boilerplate package provides an example of the use of rudy. You can run a development server as follows:

cd packages/boilerplate
yarn run start

The boilerplate should be accessible at http://localhost:3000.

You can edit any of the source code (anywhere in the repository) and the server/browser will update accordingly, including HMR and with source maps.

Debugging

You can use the usual methods to debug errors in the browser. If there are bugs that prevent the server from serving the page you want to debug, you can debug the node process. There is a working debug configuration for Visual Studio Code in .vscode/launch.json. You can use a similar configuration to debug using any node.js debugger.

Type checking

You can check types for the entire project (to the extent that it has been ported to typescript) using the following command (in the root directory):

yarn run check-types [--watch]

Testing Rudy with another app

With yarn link

Build

To build the exported files for all packages, do yarn run build in the root directory

yarn link

To connect your app to your local build of rudy, run yarn link in packages/<package>, and then yarn link @respond-framework/<package> in your app.

Make changes

in packages/<package>, run yarn run build --watch to watch for source changes and update the built/exported files

Debugging will be easier with source maps. To use them, you should install source-map-loader and amend your app's webpack config as follows:

{
  module: {
    rules: [
      {
        test: /node_modules\/@respond-framework\//,
        enforce: 'pre',
        use: 'source-map-loader',
      },
    ]
  }
  resolve: {
    symlinks: false,
  },
}

With git packages

Commit your changes, then run ./scripts/git-release.sh.

This will create git tags pointing to commits that contain compiled versions of all packages that have changed in your branch since the last release. You can then install these from the git tags with NPM or Yarn.

Running tests

Rudy has both integration tests and unit tests.

Integration tests

in packages/integration-tests run yarn run test [--watch]

Unit tests

in packages/<package>, run yarn run test [--watch]