# codacy-remark-lint

**Repository Path**: mirrors_rtfpessoa/codacy-remark-lint

## Basic Information

- **Project Name**: codacy-remark-lint
- **Description**: Docker engine to allow Codacy to have remark-lint support
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-18
- **Last Updated**: 2026-01-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# codacy-remark-lint

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/59b2b737cd8a4745b30112a91a1db4e0)](https://www.codacy.com/app/rtfpessoa/codacy-remark-lint?utm_source=github.com&utm_medium=referral&utm_content=rtfpessoa/codacy-remark-lint&utm_campaign=Badge_Grade)
[![Codacy Badge](https://api.codacy.com/project/badge/Coverage/59b2b737cd8a4745b30112a91a1db4e0)](https://www.codacy.com/app/rtfpessoa/codacy-remark-lint?utm_source=github.com&utm_medium=referral&utm_content=rtfpessoa/codacy-remark-lint&utm_campaign=Badge_Coverage)
[![CircleCI](https://circleci.com/gh/rtfpessoa/codacy-remark-lint.svg?style=svg)](https://circleci.com/gh/rtfpessoa/codacy-remark-lint)
[![Docker Version](https://images.microbadger.com/badges/version/rtfpessoa/codacy-remark-lint.svg)](https://microbadger.com/images/rtfpessoa/codacy-remark-lint "Get your own version badge on microbadger.com")

Docker engine to allow Codacy to have [remark-lint](https://github.com/remarkjs/remark-lint) support.

## Usage

You can create the docker by doing:

```sh
yarn run docker
```

The docker is ran with the following command:

```sh
docker run -it -v $srcDir:/src  <DOCKER_NAME>:<DOCKER_VERSION>
```

## Docs

[Tool Developer Guide](https://support.codacy.com/hc/en-us/articles/207994725-Tool-Developer-Guide)

## Test

We use the [codacy-plugins-test](https://github.com/codacy/codacy-plugins-test) to test our external tools integration.
You can follow the instructions there to make sure your tool is working as expected.

## Generate Docs

```sh
yarn run docs:gen
```

## What is Codacy

[Codacy](https://www.codacy.com/) is an Automated Code Review Tool
that monitors your technical debt, helps you improve your code quality,
teaches best practices to your developers,
and helps you save time in Code Reviews.

### Among Codacy's features

* Identify new Static Analysis issues
* Commit and Pull Request Analysis with GitHub, BitBucket/Stash, GitLab (and also direct git repositories)
* Auto-comments on Commits and Pull Requests
* Integrations with Slack, HipChat, Jira, YouTrack
* Track issues in Code Style, Security, Error Proneness, Performance, Unused Code and other categories

Codacy also helps keep track of Code Coverage, Code Duplication,
and Code Complexity.

Codacy supports PHP, Python, Ruby, Java, JavaScript, and Scala, among others.

### Free for Open Source

Codacy is free for Open Source projects.