@rowanmanning/validate-project

Validate Project

This is just a tool to validate my coding projects. It forces me to be consistent in the way my repos are organised. It's probably not worth trying to use it.

Table of Contents

• Requirements
• Usage
• Contributing
• License

Requirements

This library requires the following to run:

• Node.js 18+

Usage

Install with npm:

npm install -g @rowanmanning/validate-project

Alternatively use the npx command bundled with npm. The rest of the examples assume you're doing this.

Basics:

npx @rowanmanning/validate-project

Validate a general Git repo:

npx @rowanmanning/validate-project --type git

Validate a general Git repo + Node.js project:

npx @rowanmanning/validate-project --type git node

Validate a general Git repo + Node.js project, and then auto-fix issues:

npx @rowanmanning/validate-project --type git node --fix

Types

The valid types are:

• git: the basics for a Git-based project
• node: the basics for a Node.js-based project
• node-arc-app: a Node.js Architect-based application
• node-express-app: a Node.js Express-based application
• node-library: a Node.js project published to npm

Contributing

Genuinely unless you're Rowan Manning, you probably don't need to contribute to this. However if you decide you really need to, then the contributing guide is available here. All contributors must follow this library's code of conduct.

License

Licensed under the MIT license.
Copyright © 2022, Rowan Manning