markdownlint | js style checker and lint tool

 by   DavidAnson JavaScript Version: 0.34.0 License: MIT

kandi X-RAY | markdownlint Summary

kandi X-RAY | markdownlint Summary

markdownlint is a JavaScript library typically used in Utilities applications. markdownlint has no bugs, it has no vulnerabilities, it has a Permissive License and it has medium support. You can install using 'npm i markdownlint-micromark' or download it from GitHub, npm.

The Markdown markup language is designed to be easy to read, write, and understand. It succeeds - and its flexibility is both a benefit and a drawback. Many styles are possible, so formatting can be inconsistent. Some constructs don't work well in all parsers and should be avoided. The CommonMark specification standardizes parsers - but not authors. markdownlint is a static analysis tool for Node.js with a library of rules to enforce standards and consistency for Markdown files. It was inspired by - and heavily influenced by - Mark Harrison's markdownlint for Ruby. The initial rules, rule documentation, and test cases came directly from that project.
Support
    Quality
      Security
        License
          Reuse

            kandi-support Support

              markdownlint has a medium active ecosystem.
              It has 3863 star(s) with 641 fork(s). There are 61 watchers for this library.
              There were 2 major release(s) in the last 12 months.
              There are 69 open issues and 479 have been closed. On average issues are closed in 93 days. There are 3 open pull requests and 0 closed requests.
              It has a neutral sentiment in the developer community.
              The latest version of markdownlint is 0.34.0

            kandi-Quality Quality

              markdownlint has 0 bugs and 0 code smells.

            kandi-Security Security

              markdownlint has no vulnerabilities reported, and its dependent libraries have no vulnerabilities reported.
              markdownlint code analysis shows 0 unresolved vulnerabilities.
              There are 0 security hotspots that need review.

            kandi-License License

              markdownlint is licensed under the MIT License. This license is Permissive.
              Permissive licenses have the least restrictions, and you can use them in most projects.

            kandi-Reuse Reuse

              markdownlint releases are not available. You will need to build from source code and install.
              Deployable package is available in npm.
              Installation instructions are not available. Examples and code snippets are available.
              It has 86 lines of code, 0 functions and 79 files.
              It has low code complexity. Code complexity directly impacts maintainability of the code.

            Top functions reviewed by kandi - BETA

            kandi has reviewed markdownlint and discovered the below as its top functions. This is intended to give you an instant insight into markdownlint implemented functionality, and help decide if they suit your requirements.
            • Lint the content from a file
            • Called when a rule is defined
            • Lint options .
            • Get the enabled rules per line
            • Called when an error occurs
            • Extend inline code span span
            • Validates a rule object
            • Generate lint results for each rule .
            • List of markdown input .
            • Sort results and return an array of results
            Get all kandi verified functions for this library.

            markdownlint Key Features

            No Key Features are available at this moment for markdownlint.

            markdownlint Examples and Code Snippets

            No Code Snippets are available at this moment for markdownlint.

            Community Discussions

            QUESTION

            Markdown headings not appearing in outline box in VS Code
            Asked 2022-Mar-20 at 12:57

            While editing a markdown document in VS Code, the outline box does not show me the outline of the markdown document; it's completely blank/empty. I've disabled all extensions with no change in behavior (and I only had one markdown-related extension anyway, markdownlint). I don't know that this has ever worked, but it certainly has not for the last several months.

            • OS: Mac OS 12.3
            • VS Code: 1.65.2

            ...

            ANSWER

            Answered 2022-Mar-20 at 12:57

            Out of the box, Markdown headings should show up in the outline view as text nodes:

            If the outline view is configured not to show strings, Markdown headers won't appear.

            Take a look at the Outline: Show Strings setting in your preferences and make sure it's enabled.

            This setting is called outline.showStrings. If you wish to enable it only for Markdown files, you should be able to disable the feature globally and then add something like this to your settings.json:

            Source https://stackoverflow.com/questions/71511401

            QUESTION

            Angular 11 is not running ngcc
            Asked 2021-Apr-19 at 19:46

            I have an old Angular application, which I have upgraded from Angular 9 to Angular 11. (It had many stable upgrades throughout the years, starting from Angular 2)

            My problem is, that the ngcc is not running ng build:

            ...

            ANSWER

            Answered 2021-Feb-03 at 14:10

            My problem was that an another tsconfig file was overwriting the root's definitions, and turned off ivy and ngcc altogether.

            sr5c/tsconfig.app.json:

            Source https://stackoverflow.com/questions/65901974

            QUESTION

            Markdown - why inserting raw html element in markdown document is not recommended?
            Asked 2021-Jan-19 at 19:54

            I used to write posts by markdown.

            When I insert html elements in markdown document, markdownlint tell me that the document violates the markdown rule "MD033 - Inline html".

            Rule "MD033 - Inline html" is triggered whenever raw HTML is used in a markdown document.

            However, I don't know why inline html element is not allowed in markdown document.

            I have searched it in google, but I can't find it.

            If anyone who read this post know this, please let me know.

            Always Thanks.

            ...

            ANSWER

            Answered 2021-Jan-19 at 19:54

            Linters encourage best practices and are often more strict than the syntax rules and/or parser/compiler. Wikipedia states that "a linter, is a static code analysis tool used to flag programming errors, bugs, stylistic errors, and suspicious constructs."

            While programming errors will cause things to break, stylistic errors may only be recognizable by looking at a document. Therefore, organizations often define a style guide that they require all contributors to a project to follow.

            A style guide or manual of style is a set of standards for the writing, formatting and design of documents. ... A style guide establishes standard style requirements to improve communication by ensuring consistency both within a document, and across multiple documents. Because practices vary, a style guide may set out standards to be used in areas such as punctuation, capitalization, citing sources, formatting of numbers and dates, table appearance and other areas. The style guide may require certain best practices in usage, language composition, visual composition, orthography and typography.

            Obviously, a linter is ideal for flagging anything that doesn't fit within an organization's style guide.

            That said, some may only use a linter to flag programming errors and bugs, but not care about "stylistic errors," which will not change the behavior of the output. For example, a Markdown linter may require a blank line between a header and the paragraph that follows it, while Markdown does not strictly require a blank line in that location. If you don't have a style guide which requires the blank line, then you may not want your linter to enforce that blank line.

            For this reason, linters are customizable. You can configure the linter to only run the subset of rules which match your style guide. Some rules may even accept different configuration options which alter what they consider to be acceptable.

            Generally, a linter will default to a configuration that is common among most of its users. However, each organization may have minor tweaks here and there to make. Therefore, you may need to configure the linter you are using to meet your requirements.

            So, why might a style guide (and by extention a linter) disallow inline raw HTML? It's hard to say. You would need to ask the people who authored those style guides. However, we can make a few guesses.

            It could be that the style guide also requires that only very basic inline styling be done to the text of the document. Perhaps anything that is allowed is completely achievable with Markdown syntax. In that case, a linter rule which disallows inline raw HTML is an easy and effective way to enforce that requirement of the style guide.

            Another consideration is the philosophy behind Markdown itself. As the creator of Markdown explains:

            Markdown is intended to be as easy-to-read and easy-to-write as is feasible.

            Readability, however, is emphasized above all else. A Markdown-formatted document should be publishable as-is, as plain text, without looking like it’s been marked up with tags or formatting instructions.

            Raw HTML tags detract from that goal, and therefore many view them as undesirable in their Markdown documents. I suspect this is the reason why the linter defaults to this behavior, but you would need to ask the developers of the linter to be sure.

            Of course, if that doesn't fit your needs, or you don't care so much about readability, then you are free to include as many raw HTML tags in your documents as you want. However, you will then need to also custom configure any linter you use so that it ignores rule "MD033".

            Source https://stackoverflow.com/questions/65785047

            QUESTION

            How to have different markdownlint rules for CHANGELOG.md files
            Asked 2020-Dec-11 at 14:40

            In VS Code, I use markdownlint for my markdown files. I like the rules that it imposes except for my CHANGELOG.md file (see keepachangelog.com).

            Is there a way to have one set of rules for most of my markdown files and another set for the change log?

            ...

            ANSWER

            Answered 2020-Dec-11 at 14:40

            You can use custom markdownlint configuration for a file by using the following syntax:

            Source https://stackoverflow.com/questions/65218768

            QUESTION

            Which is the proper language for fenced code blocks when representing directory & file structure in Markdown syntax?
            Asked 2020-Apr-28 at 15:54

            I want to represent my directory & file structure in Markdown syntax with fenced code blocks like this:

            ...

            ANSWER

            Answered 2020-Apr-28 at 15:54

            There's text for non-highlighted fenced blocks compliant with MD040. I'm not sure how much official in Markdown world that is but it is listed in Github's linguist languages.yml as supported highlighted (in fact non-highlighted) language.

            Source https://stackoverflow.com/questions/61452980

            QUESTION

            VSCode - Custom react snippets not working in javascriptreact.json file and also javascript.json file
            Asked 2020-Jan-23 at 17:46

            VSCode Version:

            ...

            ANSWER

            Answered 2020-Jan-23 at 17:46

            Answering my own question as finally reached to the solution from VS Codes very helpful and great team (https://github.com/microsoft/vscode/issues/88936)

            And this is how got closer to the source of the problem - got this strange behaviour, in a React Component.js file when I type the snippet ('clmi' in this case) - before the React Component File's return() statement, I get the expected behaviour. But if I type the snippet ('clmi') inside the return() statement, I dont get anything. i.e. the snippet does not give me the code completion option inside the return () statment.

            The source was that VSCode was not recognizing this file to be a "javascriptreact" language type.

            Solution was as below

            In a React Component's .js file, try the tokens inspector via "F1 > Inspect TM Scopes" and position the cursor at those insert position. That will tell you the detected, embedded language. Depending on your grammar it might be a different language

            And bleow is what I am getting.

            So as you can see, this not JavaScript nor JavaScript React but the jsx-attr language. So now I had to target that type with vscode snippet

            So now, I put the whole snippet in the jsx-attr type target file ~/.config/Code/User/snippets/jsx-attr.json

            And now the custom snippets worked as expected.

            Source https://stackoverflow.com/questions/59810935

            Community Discussions, Code Snippets contain sources that include Stack Exchange Network

            Vulnerabilities

            No vulnerabilities reported

            Install markdownlint

            You can install using 'npm i markdownlint-micromark' or download it from GitHub, npm.

            Support

            See CONTRIBUTING.md for more information.
            Find more information at:

            Find, review, and download reusable Libraries, Code Snippets, Cloud APIs from over 650 million Knowledge Items

            Find more libraries
            Install
          • npm

            npm i markdownlint

          • CLONE
          • HTTPS

            https://github.com/DavidAnson/markdownlint.git

          • CLI

            gh repo clone DavidAnson/markdownlint

          • sshUrl

            git@github.com:DavidAnson/markdownlint.git

          • Stay Updated

            Subscribe to our newsletter for trending solutions and developer bootcamps

            Agree to Sign up and Terms & Conditions

            Share this Page

            share link

            Explore Related Topics

            Consider Popular JavaScript Libraries

            freeCodeCamp

            by freeCodeCamp

            vue

            by vuejs

            react

            by facebook

            bootstrap

            by twbs

            Try Top Libraries by DavidAnson

            vscode-markdownlint

            by DavidAnsonJavaScript

            markdownlint-cli2

            by DavidAnsonJavaScript

            ConvertTo-Jpeg

            by DavidAnsonPowerShell

            markdownlint-cli2-action

            by DavidAnsonJavaScript

            DHCPLite

            by DavidAnsonC++