https://github.com/wuz/archives

A new style of code documentation with a built in linter.
https://github.com/wuz/archives

Last synced: 3 months ago
JSON representation

A new style of code documentation with a built in linter.

• Host: GitHub
• URL: https://github.com/wuz/archives
• Owner: wuz
• License: mit
• Created: 2019-09-12T12:50:47.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2020-01-18T03:35:53.000Z (over 5 years ago)
• Last Synced: 2025-02-05T20:05:35.627Z (4 months ago)
• Language: JavaScript
• Size: 13.7 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# archives: a new way to do code documentation

[![Documentation style: archives](https://img.shields.io/badge/docstyle-archives-lightblue.svg)](https://github.com/wuz/archives)

**archives** is a new style of code documentation, as well as a linter for the documentation itself. It can help you ensure that your docstrings in your classes and functions stay up to date, and that they adequately explain their purpose, arguments, and return value.

![Perhaps the archives are incomplete](https://i.kym-cdn.com/entries/icons/original/000/023/967/obiwan.jpg)

## Features

- linter for jsdoc style strings (work in progress, but usable)

- (coming soon) documentation generator

## Usage

### Installation

```bash

npm install archives

```

### Run the Linter

```bash

# run archives (on itself!)

archives archives.js

```

## Todo

- more rules

- better system for multi-check rules

- more output formats

- potentially spell-checking inside desc?

- documentation generator

- tests

- publish