feat: add vscode configurations

bhajneet commented 3 years ago

Summary of PR

Adding a base config for repos. Note there are many other extensions we recommend. None of the following has been implemented. For examples:

Gurmukhi Utils

"kavod-io.vscode-jest-test-adapter" for testing

Website

"graphql.vscode-graphql" idk what for -- didn't use this myself yet, but I would imagine it ties in with gatsby

Docs

"yzhang.markdown-all-in-one" to create the table of contents in markdown
"davidanson.vscode-markdownlint" formatter / linter, this one has config given below, which can be added to settings.json as well
"bierner.markdown-emoji" to show emojis supported by github in markdown preview of vscode
"bierner.markdown-preview-github-styles" to make vs codes preview match more closely with github's preview

Format/Lint rules for markdown:

"markdownlint.config": {
  "default": true,
  "heading-increment": true,
  "heading-style": { "style": "atx" },
  "no-missing-space-atx": true,
  "no-multiple-space-atx": true,
  "heading-start-left": true,
  "no-emphasis-as-heading": false,
  "hr-style": { "style": "---" },
  "ul-style": { "style": "dash" },
  "list-indent": true,
  "blanks-around-lists": true,
  "fenced-code-language": true,
  "code-block-style": { "style": "fenced" },
  "code-fence-style": { "style": "backtick" },
  "no-space-in-code": true,
  "no-multiple-space-blockquote": true,
  "no-space-in-emphasis": true,
  "no-reversed-links": true,
  "no-space-in-links": true,
  "no-empty-links": true,
  "no-inline-html": {
    "allowed_elements": ["a", "code", "image", "img"]
  },
  "single-trailing-newline": true
},

Personal

And then there are some extension I use personally which may or may not be helpful to our team:

"xabikos.javascriptsnippets" for adding code snippets really quickly (e.g. clg<tab> expands to console.log(<cursor>))
"yo1dog.cursor-align" for making pretty code blocks (e.g. contributing.md)

Tests for unexpected behavior

none_whatsoever

Time spent on PR

10 minutes

Reviewers

@Harjot1Singh

Harjot1Singh commented 3 years ago

Could you please redo the PR?

bhajneet commented 3 years ago

Looks like you already did here https://github.com/shabados/actions/commit/937ddba70b7aa3071351152e7b1bda7bf5e0bb02

Do you want to include any of the extensions/settings mentioned in OP?

Harjot1Singh commented 3 years ago

I've committed the extensions directly to main.

shabados / actions