874
edits
(→memory: added to getLiveObjects()) |
(→Introduction: Added more headings and a section on what's out of scope) |
||
| Line 3: | Line 3: | ||
The Cuddlefish Minilib builds on [[Labs/Jetpack/JEP/25|JEP 25 - Boosters]] to provide a basic infrastructure for developing traditional XULRunner Extensions. It will also be the basis for Jetpack, as Jetpack itself is a XULRunner Extension. | The Cuddlefish Minilib builds on [[Labs/Jetpack/JEP/25|JEP 25 - Boosters]] to provide a basic infrastructure for developing traditional XULRunner Extensions. It will also be the basis for Jetpack, as Jetpack itself is a XULRunner Extension. | ||
In many ways, this JEP is a refactored formalization of Jetpack's current implementation that will allow many of Jetpack's benefits to be leveraged by any XULRunner Extension. | == Motivation and Rationale == | ||
In many ways, this JEP is a refactored formalization of Jetpack's current implementation that will allow many of Jetpack's benefits to be leveraged by any XULRunner Extension. Additionally, by moving to a SecurableModule-based architecture, Jetpack's runtime can easily be decoupled from the about:jetpack page, which will resolve a number of deficiencies (such as the inability to look at the API documentation and use the built-in code editor simultaneously). | |||
== Requirements and Scope == | |||
To address issues present in traditional Extension development, Cuddlefish provides the following: | To address issues present in traditional Extension development, Cuddlefish provides the following: | ||
| Line 20: | Line 24: | ||
As is implied by the word "minilib", Cuddlefish is intended to be very small and only contain the bare minimum of functionality that all extensions need. This means, for instance, that a module that wraps clipboard access, or a module that computes SHA1 hashes, will not be included in Cuddlefish—though such modules may certainly be bundled with an extension and easily loaded using Cuddlefish. | As is implied by the word "minilib", Cuddlefish is intended to be very small and only contain the bare minimum of functionality that all extensions need. This means, for instance, that a module that wraps clipboard access, or a module that computes SHA1 hashes, will not be included in Cuddlefish—though such modules may certainly be bundled with an extension and easily loaded using Cuddlefish. | ||
The following are outside the scope of Cuddlefish: | |||
* Cuddlefish doesn't "touch" the command line at all; it's just a drop-in library to include in existing XULRunner Extensions or applications. As such, the following are out of scope: | |||
:* A tool for creating new XULRunner Extension or application directory structures "from scratch". | |||
:* A build system for creating XPIs or XULRunner applications. | |||
* A documentation system. | |||
* A package management system. | |||
== Usage == | == Usage == | ||
edits