Completely refactor build system #205
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The goals of this refactoring are the following: - Improve code quality of the build system - Prepare code base for adding code coverage - Prepare code base for exposing the build system as a package export, so platforms can build their `cordova.js` during their build (or creation) process. This would make the JS build using coho obsolete. - Prepare code base to remove dependency on Grunt The build process now lives under `build-tools` (was `tasks`). It does not depend on Grunt anymore but is written in plain Node.js. The original Grunt interface for building (as used by coho) was preserved and is implemented in `Gruntfile.js` using the new build system. The `platformName` option and support for getting platform paths from the `cordova-platforms` key in `package.json` have been removed from the Grunt interface, but neither of those are used in coho. The logic that is specific to the test build has been extracted from the rest of the build. It now lives in `test/build.js` and is run automatically during `npm test`. The following dependencies have been added: - execa - fs-extra - globby I have taken extra care to preserve the exact format of the built file. This means that the correctness of the refactoring can be verified by simply diffing the build artifacts in `pkg` created with and without this change.
raphinesse
added a commit
to raphinesse/cordova-js
that referenced
this pull request
Jul 22, 2019
In apache#205 I took great care to preserve the _exact_ format of the built JS code, so the build refactoring could be verified by diffing the build output. However, some of the existing formatting is sub-optimal so this commit optimizes it a little. Most notably, this commit will change file path comments to be relative paths, not absolute ones. An example for this: ```diff -// file: /home/raphinesse/code/cordova-android/cordova-js-src/exec.js +// file: ../cordova-android/cordova-js-src/exec.js ```
raphinesse
added a commit
that referenced
this pull request
Jul 22, 2019
In #205 I took great care to preserve the _exact_ format of the built JS code, so the build refactoring could be verified by diffing the build output. However, some of the existing formatting is sub-optimal so this commit optimizes it a little. Most notably, this commit will change file path comments to be relative paths, not absolute ones. An example for this: ```diff -// file: /home/raphinesse/code/cordova-android/cordova-js-src/exec.js +// file: ../cordova-android/cordova-js-src/exec.js ```
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation and Context
The goals of this refactoring are the following:
build their
cordova.jsduring their build (or creation) process.This would make the JS build using coho obsolete.
Description
The build process now lives under
build-tools(wastasks). It doesnot depend on Grunt anymore but is written in plain Node.js.
The original Grunt interface for building (as used by coho) was
preserved and is implemented in
Gruntfile.jsusing the new buildsystem. The
platformNameoption and support for getting platform pathsfrom the
cordova-platformskey inpackage.jsonhave been removedfrom the Grunt interface, but neither of those are used in coho.
The logic that is specific to the test build has been extracted from
the rest of the build. It now lives in
test/build.jsand is runautomatically during
npm test.The following dependencies have been added:
Testing
I have taken extra care to preserve the exact format of the built file.
This means that the correctness of the refactoring can be verified by
simply diffing the build artifacts in
pkgcreated with and withoutthis change.
Checklist