Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

markdown checker #226

Draft
wants to merge 36 commits into
base: main
Choose a base branch
from
Draft

Conversation

oyilmaztekin
Copy link
Contributor

#140

  • added markdown reader
  • parsed markdown to the AST
  • detected all tables
  • collected all link definitions
  • started to add tests

Discussions: #140 (comment)

added parser

detected all tables into the MD file

collected all link definitions

started to add tests
package.json Outdated Show resolved Hide resolved
package.json Outdated Show resolved Hide resolved
changed pacakge publication to private
@oguzzkilic
Copy link

Adding it in eslint + airbnb configuration can be good for code standard.

oyilmaztekin and others added 10 commits July 3, 2019 00:30
Co-Authored-By: Jordan Harband <[email protected]>
Co-Authored-By: Jordan Harband <[email protected]>
Co-Authored-By: Jordan Harband <[email protected]>
Co-Authored-By: Jordan Harband <[email protected]>
Co-Authored-By: Jordan Harband <[email protected]>
Co-Authored-By: Jordan Harband <[email protected]>
Co-Authored-By: Jordan Harband <[email protected]>
added missing newlines
tools/markdown-checker/index.js Outdated Show resolved Hide resolved
tools/markdown-checker/lib/analyzer/analyzeTable.js Outdated Show resolved Hide resolved
tools/markdown-checker/lib/transformer/traverser.js Outdated Show resolved Hide resolved
@septs
Copy link
Member

septs commented Sep 27, 2020

@ljharb

  1. I want to integrate https://github.com/DavidAnson/markdownlint in gh-actions on push and pull-request pre-check

  2. I want to integrate a link checker that is available every day

    1. check is redirected (3xx status code)
      e.q: repo transferred or renamed

    2. check is not found (404 status code)
      e.q: repo deleted

    3. don't check not github

  3. Add Visual Studio Code pre-settings

    1. .vscode/settings.json
    {
        "editor.formatOnSave": true, // auto format
        "editor.codeActionsOnSave": {
        "source.fixAll": true // auto fix
     }
    }
    
    1. .vscode/extensions.json

    prompt to install extensions

    {
      "recommendations": ["DavidAnson.vscode-markdownlint"]
    }
    

@Jack-Works
Copy link
Member

Not everyone using VSCode.

@ljharb
Copy link
Member

ljharb commented Sep 28, 2020

Definitely editor-specific stuff isn't a good idea to include. If it's a linter tho, it should be able to run locally via eslint, which would be fine.

The trick with an action (or any CI check) is that inevitably someone's going to be blocked by a link going dark when it's unrelated to the change they're making. What we really need is something that can notice a link is dead, and then open up a PR or issue about it.

@septs
Copy link
Member

septs commented Sep 28, 2020

@ljharb i think, i can integrate one link-checker on github action

on push and scheduled (run once a day)

@ljharb
Copy link
Member

ljharb commented Sep 28, 2020

@septs how would we be notified when it failed? would that cause PRs to suddenly be blocked?

@septs
Copy link
Member

septs commented Sep 28, 2020

@ljharb ye, will a notification, but will not prevent PR.

@septs
Copy link
Member

septs commented Sep 28, 2020

.idea/.gitignore Outdated Show resolved Hide resolved
.gitignore Outdated Show resolved Hide resolved
@oyilmaztekin
Copy link
Contributor Author

oyilmaztekin commented Sep 11, 2021

@ljharb @littledan @chicoxyzzy final JSON output was created for stage 1. Still, things need to be improved, but let's discuss the output json file that has been added to the commit. This output was created automatically. Also, you can share your concerns about deployment pipeline implementation and the code quality.

For refreshing memories of what this PR was about
#140 (comment)
#188

@oyilmaztekin
Copy link
Contributor Author

In addition, you can review the JSON output here. It will be the final result after we are done with that PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants