project.yaml v0.1.4

One project.yaml to rule them all!

NOTE: this tool is used for the MolView project and is not stable.

This command-line tool provides the ability to define project information such as the project name, version, description and license only once in a project.yaml. Running the projectyaml command will sync these values with other configuration files such as package.json and bower.json. It will also compare the global configuration values with those in other YAML configuration files like pubspec.yaml. The values are not directly copied to YAML files because YAML files are often manually formatted.

Install

npm install --global project.yaml

Use

projectyaml

Supported values

name:        My Project
version:     1.0.0
copyright:   2015
author:      John Doe
contributors:
    - Joe Bloggs
    - Joe Bloggs <joe@bloggs.com>
    - Joe Bloggs <joe@bloggs.com> (http://joebloggs.com)
description: Awesome project!
license:     AGPL-3.0
category:    Science
homepage:    http://example.com
repository:
    type:    git
    url:     https://github.com/username/repository.git
bugs:
    url:     https://github.com/username/repository/issues
    email:   bugs@example.com

Notes

• The author will be recognized as primary author and maintainer and should not be repeated in the contributors array.

Supported third-party files

• package.json
• bower.json
• pubspec.yaml