JanusGraph / JanusGraph/janusgraph

Support local linting jobs that match codacy rules.

Open
#1,613 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
5.8k
Forks
1.2k
Avg merge
13h 53m
Merged PRs (30d)
6

Description

From some of my markdown Codacy fixes I found this doc on [using remark to find the Codacy linting errors.](https://github.com/remarkjs/remark-lint#using-remark-to-fix-your-markdown)

I think we should maybe add something into Maven to run all the linting checks we use in CI.

For now here's my workaround to test markdown locally with the Codacy rules

### Install
```Shell
npm install -g remark-preset-lint-recommended remark-cli
```

#### Run against the full project
```
remark . --use remark-preset-lint-recommended
```

#### Run against a single file
```
remark RELEASING.md --use remark-preset-lint-recommended
```

#### Troubleshooting
If you're on mac and there's an error that remark-preset-lint-recommended can't be found make sure `NODE_PATH` is set to the prefix listed in `npm config ls` + `/lib/node_modules`
```Shell
export NODE_PATH="/usr/local/lib/node_modules"
```

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the Maven build and the CI linting configuration, then compare them with the documented remark commands for the full project and RELEASING.md. Done means the linting checks used in CI can also be run locally through Maven, with the existing markdown rules reproduced.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
build-system, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.