Projectz

Stop wasting time syncing and updating your project's README and Package Files!

Used by over 300 repositories and 200 projects thus far!

Watch the talk.

Here's some of the things it can do:

Keep your projects data files synchronised appropriately, supports:
- package.json
- bower.json
- component.json
- jquery.json
Create beautiful standardised readme files that stay in sync with your data files, supports:
- README
- CONTRIBUTING
- LICENSE
- BACKERS
- HISTORY
Automatic injection of the appropriate installation methods, supports:
- npm
- jspm
- Component
- Bower
- Editions
- DocPad Plugins
Automatic injection of your desired badges
Automatic injection of your SPDX license information
Keep your data and readme files up to date with remote data, supports:
- Pulling in your latest contributors from GitHub
- Pulling in your latest sponsors from remote APIs (coming soon)

Install

npm

Install Globally

Install: npm install --global projectz
Executable: projectz

Install Locally

Install: npm install --save projectz
Executable: npx projectz
Require: require('projectz')

Editions

This package is published with the following editions:

projectz aliases projectz/source/index.js
projectz/source/index.js is esnext source code with require for modules

Environments older than Node.js v8 may need Babel's Polyfill or something similar.

Running Projectz

Directly

Once installed locally, you can compile your project using projectz by running the following in your terminal:

npx projectz compile

Automatically

To make projectz more automatic, we recommended adding the direct command above to your build tool.

If you don't use a build tool, but do use npm, then you can add the following to your project's package.json file:

{
    "scripts": {
        "compile": "projectz compile",
        "posttest": "npm run compile"
    }
}

The compile script here is runnable via the command npm run-script compile and will compile your project with projectz.

The posttest script here automatically compiles your project with projectz after your tests have successfully completed, providing you use npm test to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.

GitHub Rate Limiting

If you get a rate limit warning, you will need to add GITHUB_ACCESS_TOKEN (or a GITHUB_CLIENT_ID AND GITHUB_CLIENT_SECRET combination) to your environment. To do this:

Create a personal access token for your computer at: https://github.com/settings/tokens
Projectz needs the readonly/access permissions for repos and users
Generate the token and copy it
Inside your dotfile profile (.bashrc, .zshrc) add export GITHUB_ACCESS_TOKEN="the token value"
Open a new shell, or run export GITHUB_ACCESS_TOKEN="the token value" in your current shell
Run projectz again

Configuring Projectz

Data Files

Projectz helps you maintain the following data files:

package.json
bower.json
component.json
jquery.json

It does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.

If you are making use of multiple meta data files, you may find defining a projectz meta file (projectz.json for JSON, or projectz.cson for CSON) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.

Projectz takes notes of these meta data fields:

{
    // Specify your project's human readable name
    "title": "Projectz",

    // Specify your project name
    "name": "projectz",

    // Specify your project's Website URL
    "homepage": "https://github.com/bevry/projectz",

    // Specify your project's demo URL
    // If this is missing, and `homepage` is set, we set it to the `homepage` value
    "demo": "https://github.com/bevry/projectz",

    // Specify your project description
    "description": "Stop wasting time syncing and updating your project's README and Package Files!",

    // Specify your project's SPDX License
    // Uses https://www.npmjs.com/packages/spdx for parsing
    "license": "MIT",

    // Specify your whether the project can run on the client-side in web browsers
    // If this is missing, and the component or bower package files exist, then this becomes `true`
    "browsers": true,

    // Specify your project's author details
    // Can be an array or CSV string
    "author": "2013+ Bevry Pty Ltd <us@bevry.me> (http://bevry.me)",

    // Specify your maintainers
    "maintainers": [
        "Benjamin Lupton (b@lupton.cc) (http://balupton.com)"
    ],

    // Specify your sponsors
    "sponsors": [
        "Benjamin Lupton (b@lupton.cc) (http://balupton.com)"
    ],

    // Specify your contributors
    // This is automatically combined with the contributors from the GitHub Repository API
    "contributors": [
        "Benjamin Lupton (b@lupton.cc) (http://balupton.com)"
    ],

    // Specify your project's repository details
    // If this is missing, and `homepage` is a GitHub URL, this determined automatically
    "repository": {
        "type": "git",
        "url": "https://github.com/bevry/projectz.git"
    },

    // Specify your project's issue tracker
    // If this is missing, and `repository` is a GitHub repository, this determined automatically
    "bugs": {
        "url": "https://github.com/bevry/projectz/issues"
    },

    // Specify your project's badges for use in the readme files
    // Projectz renders badges by sending the `badges` field to the `badges` package.
    // Below is some sample projectz configuration for this field to render our most common badges.
    // Even more badge types and configurations are available than just those included below.
    // Complete details of what is available can be found over at the badges package:
    // https://github.com/bevry/badges
    "badges": {
        "list": [
            "travisci",
            "npmversion",
            "npmdownloads",
            "daviddm",
            "daviddmdev",
            "---",
            "slackin",
            "patreon",
            "gratipay",
            "flattr",
            "paypal",
            "bitcoin",
            "wishlist"
        ],
        "config": {
            "patreonUsername": "bevry",
            "gratipayUsername": "bevry",
            "flattrUsername": "balupton",
            "paypalURL": "https://bevry.me/paypal",
            "bitcoinURL": "https://bevry.me/bitcoin",
            "wishlistURL": "https://bevry.me/wishlist",
            "slackinURL": "https://slack.bevry.me"
        }
    },

  // If you are using the projectz meta file, you can also define this field
  // it allows you to set the configuration for other package systems
  "packages": {
    "bower": {},
    "component": {},
    "jquery": {}
  }
}

Readme Files

Projectz helps you maintain the following readme files:

README.md
CONTRIBUTING.md
LICENSE.md
BACKERS.md
HISTORY.md

It does this by reading them, and replacing comment tags with the appropriate data.

The following comment tags are supported:

 — outputs the package's title field
 — outputs the badges you have enabled from your package's badges field
 — outputs the package's description field
 — outputs the package's installation instructions
 — outputs a link to the HISTORY file if it exists, otherwise if it is a Github repository, outputs a link to the releases page
 — outputs a link to the CONTRIBUTE file if it exists
 — outputs who the backers are for the project, including maintainers, sponsors, funding badges, and contributors
 — outputs a summary of the license information

As well as these comment tags for updating entire files:

 — outputs the complete license information
 — same as  but made for an individual file instead

As an example, here is a a basic README.md file:

<!-- TITLE -->
<!-- BADGES -->
<!-- DESCRIPTION -->
<!-- INSTALL -->

## Usage
Usage instructions go here

<!-- HISTORY -->
<!-- CONTRIBUTE -->
<!-- BACKERS -->
<!-- LICENSE -->

This README is also, expectedly, built with projectz. View its source.

History

Discover the release history by heading on over to the HISTORY.md file.

Contribute

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

Backers

Maintainers

These amazing people are maintaining this project:

Contributors

These amazing people have contributed code to this project:

Benjamin Lupton — view contributions
Peter Flannery — view contributions
Rob Loach — view contributions
James George — view contributions
Zearin — view contributions
vsopvsop — view contributions
Zlatan Vasović — view contributions
Peter Chanthamynavong — view contributions
Shahar Dawn Or — view contributions
dependabot-preview[bot] — view contributions