xgovw

An engine which ensures xGov meet certain requirements.

Getting Started

To install xgovw and validate the xGov repository:

git clone git@github.com:algorandfoundation/xgovw.git
cargo install --path=xgovw xgovw
xgovw /path/to/xGov

USAGE:
    xgovw [OPTIONS] [SOURCES]...

ARGS:
    <SOURCES>...    Files and/or directories to check

OPTIONS:
        --format <FORMAT>     Output format [default: text] [possible values: text, json]
    -h, --help                Print help information
        --lints <LINTS>       Additional lints to enable
        --list-lints          List all available lints
        --no-default-lints    Do not enable the default lints

Demo

Example xgov

---
title: The proposal title is a few words, not a complete sentence
author: Stéphane Barroso(@sudoweezy)
company_name: Name of the company
category: dApps
focus_area: Banking
open_source: Yes
amount_requested: 1000
status: Final
---

# xGov Submission

## Team
Information about the team members and their qualifications, including relevant experience and skills.

## Abstract
A brief overview of the proposal and its main objectives.

## Experience with Algorand
Details about the team's experience with the Algorand protocol and any previous projects built on it.

## Roadmap
A detailed plan for the development and implementation of the proposal, including timelines and milestones.

## Benefits for the community
A description of the potential benefits that the proposal could bring to the Algorand community and its users.

## Additional information
Any other relevant details or documentation that the team would like to include in the proposal.

Output

error[markdown-order-section]: section `Team` must come after `Abstract`
  --> /tmp/xgov-1.md
   |
12 | ## Team

Lints

id	Description
`preamble-file-name`	The file name reflects the xgov number.
`preamble-req`	All required preamble headers are present.
`preamble-order`	The preamble headers are in the correct order.
`preamble-no-dup`	There are no duplicate headers.
`preamble-trim`	There is no extra whitespace around preamble fields.
`preamble-id`	The `id` header is a positive integer
`preamble-len-title`	The `title` header isn't too long.
`preamble-author`	The author header is correctly formatted, and there is at least one GitHub user listed.
`preamble-list-author`	The `author` header is a correctly formatted comma-separated list.
`preamble-len-company_name`	The `company_name` header isn't too long.
`preamble-len-amount_requested`	The `amount_requested` header is a at least 5 digits.
`preamble-amount_requested`	The `amount_requested` header is a positive integer
`preamble-enum-category`	The `category` header is a recognized value.
`preamble-enum-focus_area`	The `focus_area` header is a recognized value.
`preamble-enum-open_source`	The `open_source` header is a recognized value.
`preamble-enum-status`	The `status` header is a recognized value.
`markdown-req-section`	Required sections are present in the body of the proposal.
`markdown-order-section`	There are no extra sections and the sections are in the correct order.
`markdown-re-xgov-not-xgov`	Other xgovs are referenced using xGov-X, not xgov-X.
`markdown-re-xgov-dash`	Other xgovs are referenced using xGov-X, not XGOVX or xGov X.
`markdown-link-first`	First mention of an xgov must be a link.
`markdown-rel-links`	All URLs in the page are relative. (or use the html Topic) format

JavaScript / WebAssembly

xgovw-lint-js packages xgovw as an npm package, for use in JavaScript / TypeScript.

You can find the package on npm.

Building & Publishing

cargo install --path=xgovw xgovw

cd xgovw-lint-js
wasm-pack build -t nodejs
wasm-pack publish -t nodejs

algorandfoundation / xgovw