Skip to content

Commit

Permalink
Refactor out unneeded libraries (#106)
Browse files Browse the repository at this point in the history
  • Loading branch information
paulzakin authored Sep 7, 2024
1 parent be41e84 commit 64acdde
Show file tree
Hide file tree
Showing 17 changed files with 2,090 additions and 4,926 deletions.
5 changes: 1 addition & 4 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,6 @@ jobs:

- name: Use Node.js
uses: actions/setup-node@v4
with:
node-version: latest
cache: 'npm'

- name: Install dependencies
run: npm install
run: npm install -g pnpm; pnpm install
12 changes: 6 additions & 6 deletions .github/workflows/pull_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@ jobs:

- name: Use Node.js
uses: actions/setup-node@v4
with:
node-version: latest
cache: 'npm'

- name: Install dependencies
run: npm install
run: npm install -g pnpm; pnpm install

- name: Run the linter, formatter, and TypeScript compiler
run: npm run lint && npm run build
- name: Lint the extension
run: cd src && npx tsc && npx biome check

- name: Build the extension
run: pnpm build
5 changes: 1 addition & 4 deletions .github/workflows/tag.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,9 @@ jobs:

- name: Use Node.js
uses: actions/setup-node@v4
with:
node-version: latest
cache: 'npm'

- name: Install dependencies
run: npm install
run: npm install -g pnpm; pnpm install

- name: Publish
run: npx vsce publish --no-update-package-json --no-git-tag-version -p ${{ secrets.AZURE_TOKEN }} ${{ github.ref_name }}
9 changes: 8 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,12 @@
"out": true
},
"typescript.tsc.autoDetect": "off",
"cSpell.words": ["biomejs", "joblint", "proselint", "textlint"]
"cSpell.words": [
"biomejs",
"joblint",
"Pandoc",
"proselint",
"textlint",
"WRITEGOOD"
]
}
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,7 @@ If a sentence is greater than 11 words, we flag it with:
The extension can also analyze your writing using these libraries:

- Joblint [^5]. Bundled with the extension.
- Proselint [^6]. Must be installed on your system.
- Write Good [^7]. Bundled with the extension.

> Note: All of these libraries are disabled by default. If desired, you can enable them in your Visual Studio Code Settings. `proselint` can also be a bit slow, so it does not run on every text change. Instead, you need to save the document for `proselint` to run.
Expand Down Expand Up @@ -65,10 +63,13 @@ Wiki links represent an internal link to another file. They have become widely a
On the flip side, if there is no match, we will flag the link as a broken link. We will also flag any asset link without a match. For example, if you write `![icon](/icon.png)` but `icon.png` does not exist, we will throw an error. Just make sure that each asset link is an absolute link. Otherwise, it will be flagged as missing by default!

[^1]: https://marketplace.visualstudio.com/items?itemName=successible.markdown-wiki

[^2]: https://en.m.wikipedia.org/wiki/Automated_readability_index

[^3]: https://readable.com/blog/what-is-the-average-persons-reading-level/

[^4]: https://insidegovuk.blog.gov.uk/2014/08/04/sentence-length-why-25-words-is-our-limit/
[^5]: https://github.com/rowanmanning/joblint

[^6]: https://github.com/amperser/proselint
[^7]: https://github.com/btford/write-good

[^8]: https://pandoc.org/installing.html
Loading

0 comments on commit 64acdde

Please sign in to comment.