Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
broccoli - npm Package Compare versions
Comparing version 1.0.0-beta.8 to 1.0.0
| # master | ||
| # 1.0.0 | ||
| * Release without change | ||
| # 1.0.0-beta.8 | ||
@@ -4,0 +8,0 @@ |
| { | ||
| "name": "broccoli", | ||
| "description": "Fast client-side asset builder", | ||
| "version": "1.0.0-beta.8", | ||
| "version": "1.0.0", | ||
| "author": "Jo Liss <joliss42@gmail.com>", | ||
@@ -39,3 +39,2 @@ "main": "lib/index.js", | ||
| "devDependencies": { | ||
| "broccoli-plugin": "^1.2.0", | ||
| "chai": "^3.3.0", | ||
@@ -42,0 +41,0 @@ "chai-as-promised": "^5.1.0", |
@@ -16,7 +16,2 @@ # Broccoli | ||
| **This is 0.x beta software.** | ||
| Windows support is still spotty. Our biggest pain point is unreliable file | ||
| deletion (see [rimraf#72](https://github.com/isaacs/rimraf/issues/72)). | ||
| ## Installation | ||
@@ -93,7 +88,2 @@ | ||
| ### A larger example | ||
| You can see a full-featured `Brocfile.js` in | ||
| [broccoli-sample-app](https://github.com/broccolijs/broccoli-sample-app/blob/master/Brocfile.js). | ||
| ## Plugins | ||
@@ -113,71 +103,13 @@ | ||
| * [broccoli-plugin](https://github.com/broccolijs/broccoli-plugin) | ||
| * [broccoli-caching-writer](https://github.com/rjackson/broccoli-caching-writer) | ||
| * [broccoli-filter](https://github.com/broccolijs/broccoli-filter) | ||
| * [broccoli-writer](https://github.com/broccolijs/broccoli-writer) | ||
| * [node-quick-temp](https://github.com/joliss/node-quick-temp) | ||
| ## Plugin API Specification | ||
| *This section needs to be updated. For now, see | ||
| [docs/broccoli-1-0-plugin-api.md](docs/broccoli-1-0-plugin-api.md) and the | ||
| [broccoli-plugin README](https://github.com/broccolijs/broccoli-plugin).* | ||
| See [docs/node-api.md](docs/node-api.md). | ||
| Broccoli defines a single plugin API: a tree. A tree object represents a tree | ||
| (directory hierarchy) of files that will be regenerated on each build. | ||
| Also see [docs/broccoli-1-0-plugin-api.md](docs/broccoli-1-0-plugin-api.md) on | ||
| how to upgrade from Broccoli 0.x to the Broccoli 1.x API. | ||
| By convention, plugins will export a function that takes one or more input | ||
| trees, and returns an output tree object. Usually your plugin will be | ||
| implemented as a class representing a tree, but it is recommended to make the | ||
| `new` operator optional | ||
| ([example](https://github.com/joliss/broccoli-coffee/blob/a55b3a6677f6d9da83334e9c916ae5e57895d1a6/index.js#L8)). | ||
| A tree object must supply two methods that will be called by Broccoli: | ||
| ### `tree.read(readTree)` | ||
| The `.read` method must return a path or a promise for a path, containing the | ||
| tree contents. | ||
| It receives a `readTree` function argument from Broccoli. If `.read` needs to | ||
| read other trees, it must not call `otherTree.read` directly. Instead, it must | ||
| call `readTree(otherTree)`, which returns a promise for the path containing | ||
| `otherTree`'s contents. It must not call `readTree` again until the promise | ||
| has resolved; that is, it cannot call `readTree` on multiple trees in | ||
| parallel. | ||
| Broccoli will call the `.read` method repeatedly to rebuild the tree, but at | ||
| most once per rebuild; that is, if a tree is used multiple times in a build | ||
| definition, Broccoli will reuse the path returned instead of calling `.read` | ||
| again. | ||
| The `.read` method is responsible for creating a new temporary directory to | ||
| store the tree contents in. Subsequent invocations of `.read` should remove | ||
| temporary directories created in previous invocations. | ||
| ### `tree.cleanup()` | ||
| For every tree whose `.read` method was called one or more times, the | ||
| `.cleanup` method will be called exactly once. No further `.read` calls will | ||
| follow `.cleanup`. The `.cleanup` method should remove all temporary | ||
| directories created by `.read`. | ||
| ### Debugging | ||
| #### Errors | ||
| When it is known which file caused a given error, plugin authors can make errors | ||
| easier to track down by setting the `.file` property on the generated error. | ||
| This `.file` property is used by both the console logging, and the server middleware | ||
| to display more helpful error messages. | ||
| #### Descriptive Naming | ||
| As of 0.11 Broccoli prints a log of any trees that took a significant amount of the total | ||
| build time to assist in finding which trees are consuming the largest build times. | ||
| To determine the name to be printed Broccoli will first look for a `.description` | ||
| property on the plugin instance then fall back to using the plugin constructor's name. | ||
| ## Security | ||
@@ -184,0 +116,0 @@ |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
No v1
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
Improved metrics
- Dev dependency count
- decreased by-10%
9
- Number of low quality alerts
- decreased by-100%
0
Worsened metrics
- Total package byte prevSize
- decreased by-4.98%
55879
- Number of lines in readme file
- decreased by-33.5%
135
No dependency changes