Skip to content

DEVELOPMENT.md

Latest commit

 

History

History
105 lines (71 loc) · 2.75 KB

DEVELOPMENT.md

File metadata and controls

105 lines (71 loc) · 2.75 KB

Development

Setup

  1. Install npm dependencies.

    npm install

Updating the parser

If there's a problem parsing, you will want to edit the grammar under lib/parser/pbxproj.pegjs.

Tests under the test/parser directory will compile the parser from the grammar. The other tests will use the prebuilt parser (lib/parser/pbxproj.js).

To build the parser js file after editing the grammar, run:

npm run build

Unit Testing

Our projects include unit tests, which can be run with:

npm test

Linting

During development, you should run the linter to ensure the code follows our coding standards:

npm run lint

Note

Running npm test will also execute the linter before running the tests.

Fixing Lint Issues

In many cases, lint warnings can be fixed automatically with:

npm run lint:fix

If an issue cannot be resolved automatically, it will require manual review and correction.

Building from Source

  1. Clone the repository locally.

  2. Change to the repository directory.

  3. Install dependencies:

    npm install

    Installs all production and development dependencies required for using and developing the package.

  4. Update sub-dependencies:

    npm update

    Over time, package-lock.json can become stale and may trigger audit warnings. npm update refreshes dependencies within the pinned versions.

    Under normal circumstances, users install the published package from the npm registry, which does not include its own package-lock.json. Instead, npm resolves and installs the latest compatible dependency versions at install time, which may result in no audit warnings.

    Running npm update locally can provide a more accurate representation of current npm audit results for the project.

  5. Generate a tarball:

    npm pack

    Creates a .tgz tarball file in the .asf-release directory.