packager icon indicating copy to clipboard operation
packager copied to clipboard

Describe a component (or file) in the sources section of the manifest

Open thomasd opened this issue 15 years ago • 0 comments

For frequently changing external files (libraries, widgets...) which do not follow the mootools package-syntax and have no description-header in their files, I added the ability to describe the components of a file in the manifest file.

Example: name: "Core" exports: "mootools-core.js" web: "mootools.net" description: "MooTools, The JavaScript framework" license: "MIT License" copyright: "© MooTools" authors: "MooTools Development Team"

sources:
  - "Source/Core/Core.js"
  - 
    - "Source/Types/Array.js"
    - name: Array
      description: Contains Array Prototypes like each, contains, and erase.
      license: MIT-style license.
      requires: Type
      provides: Array
  - "Source/Types/String.js"

Having the description in the manifest the actual source file doesn't need a header. I decided to handle the file path and the description in an array with 2 elements, but it may also be possible and maybe easier to read if you handle that in a map using the file path as key and the description map as value?!

thomasd avatar Dec 17 '10 16:12 thomasd