Skip to content

Commit ab85858

Browse files
jsorefjsoref
authored
fix(docs): lot of misspelling (lowlighter#1180) [skip ci]
1 parent e2f27e9 commit ab85858

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

59 files changed

+115
-115
lines changed

‎.github/readme/partials/documentation/organizations.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ It is possible to host workflows in the `.github` repository of organizations, a
3232
## *️⃣ Organizations memberships for user accounts
3333

3434
By default, GitHub only display public memberships.
35-
Membership visibility canbe managed in the `People` tab of your organization.
35+
Membership visibility can be managed in the `People` tab of your organization.
3636

3737
![Publish organization membership](/.github/readme/imgs/setup_public_membership_org.light.png#gh-light-mode-only)
3838
![Publish organization membership](/.github/readme/imgs/setup_public_membership_org.dark.png#gh-dark-mode-only)

‎.github/readme/partials/documentation/setup/web.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ Update profile `README.md` to include rendered image.
154154

155155
### 4️.1️ URL parameters syntax
156156

157-
The GitHub action and the web instance uses the same engine behing the hood.
157+
The GitHub action and the web instance uses the same engine behind the hood.
158158

159159
It is actually possible to generate image directly from url without passing by the web ui by knowing how to pass parameters.
160160

‎.github/readme/partials/templated/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 📊 Metrics [<img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=280144&theme=dark" alt="" align="right" width="190" height="41">](https://www.producthunt.com/posts/github-metrics?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-github-metrics)
1+
# 📊 Metrics [<img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=280144&theme=dark" alt="" align="right" width="190" height="41">](https://www.producthunt.com/posts/github-metrics?utm_source=badge-featured&utm_medium=badge&utm_source=badge-github-metrics)
22

33
[![Continuous integration](https://github.com/lowlighter/metrics/actions/workflows/ci.yml/badge.svg)](https://github.com/lowlighter/metrics/actions/workflows/ci.yml)
44

‎.github/readme/partials/templated/plugins.community.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,10 @@ Be sure to read [contribution guide](/CONTRIBUTING.md) and [architecture](/ARCHI
3434
3535
Please respect the following guidelines:
3636

37-
- A plugin should be independant and should not rely on other plugins
37+
- A plugin should be independent and should not rely on other plugins
3838
- [🧱 core](/source/plugins/core/README.md) and [🗃️ base](/source/plugins/base/README.md) output can be reused though
3939
- A plugin should never edit its original arguments, as it is shared amongst other plugins and would create unattended side effects
40-
- Use `imports.metadata.plugins.{plugin-name}.inputs()` to automatically typecheck and default user inputs through defined `metadata.yml`
40+
- Use `imports.metadata.plugins.{plugin-name}.inputs()` to automatically type check and default user inputs through defined `metadata.yml`
4141
- Plugin options should respect the "lexical field" of existing option to keep consistency
4242
- Plugin errors should be handled gracefully by partials with error message
4343
- New dependencies should be avoided, consider using existing `imports`
@@ -210,7 +210,7 @@ export default async function(
210210
{
211211
login, //GitHub username
212212
q, //Raw user inputs (dot notation without plugin_ prefix, don't use it directly)
213-
imports, //Various utilitaires (axios, puppeteer, fs, etc., see /source/app/metrics/utils.mjs)
213+
imports, //Various utilities (axios, puppeteer, fs, etc., see /source/app/metrics/utils.mjs)
214214
data, //Raw data from core/base plugin
215215
computed, //Computed data from core/base plugin
216216
rest, //Rest authenticated GitHub octokit

‎.github/readme/partials/templated/plugins.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Plugins provide additional content and lets you customize rendered metrics.
55
**📦 Maintained by core team**
66
<% { let previous = null; for (const [plugin, {name, category, deprecation, authors = []}] of Object.entries(plugins).filter(([key, value]) => (value)&&(value.category !== "community")).sort(([an, a], [bn, b]) => a.category === b.category ? an.localeCompare(bn) : 0)) { %>
77
<% if (previous !== category) { previous = category -%>
8-
* **<%= `${category.charAt(0).toLocaleUpperCase()}${category.substring(1)} plugins` %>**
8+
* **<%= `${category === "github" ? "GitHub" : `${category.charAt(0).toLocaleUpperCase()}${category.substring(1)}`} plugins` %>**
99
<% } -%>
1010
* [<%- name %> <sub>`<%= plugin %>`</sub>](/source/plugins/<%= plugin %>/README.md)<%# -%><% if (deprecation) { %> <sub>`⚠️ deprecated`</sub><% } %><%# -%>
1111
<% }} %>
@@ -14,4 +14,4 @@ Plugins provide additional content and lets you customize rendered metrics.
1414
* **[Community plugins](/source/plugins/community/README.md)**
1515
<% { let previous = null; for (const [plugin, {name, category, authors = []}] of Object.entries(plugins).filter(([key, value]) => (value)&&(value.category === "community")).sort(([an, a], [bn, b]) => a.category === b.category ? an.localeCompare(bn) : 0)) { %><%# -%>
1616
* [<%- name %> <sub>`<%= plugin %>`</sub>](/source/plugins/community/<%= plugin %>/README.md) by <%- authors.map(author => `[@${author}](https://github.com/${author})`).join(" ") %>
17-
<% }} %>
17+
<% }} %>

‎.github/scripts/markdown_example.mjs

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ const browser = await puppeteer.launch({
1010
})
1111
const page = await browser.newPage()
1212

13-
//Select markdown example and take screenshoot
13+
//Select markdown example and take screenshot
1414
await page.setViewport({width: 600, height: 600})
1515
await page.goto("https://github.com/lowlighter/metrics/blob/examples/metrics.markdown.md")
1616
const clip = await page.evaluate(() => {

‎.github/workflows/examples.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -354,7 +354,7 @@ jobs:
354354
user: lowlighter
355355
plugins_errors_fatal: yes
356356
if: ${{ success() || failure() }}
357-
- name: 💡 Coding habits and activity - Midly interesting facts
357+
- name: 💡 Coding habits and activity - Mildly interesting facts
358358
uses: lowlighter/metrics@master
359359
with:
360360
filename: metrics.plugin.habits.facts.svg
@@ -806,7 +806,7 @@ jobs:
806806
user: lowlighter
807807
plugins_errors_fatal: yes
808808
if: ${{ success() || failure() }}
809-
- name: ⏱️ Google PageSpeed - Succint report
809+
- name: ⏱️ Google PageSpeed - Succinct report
810810
uses: lowlighter/metrics@master
811811
with:
812812
filename: metrics.plugin.pagespeed.svg

‎ARCHITECTURE.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -62,15 +62,15 @@ To solve this, metrics now spawns a [puppeteer](https://github.com/puppeteer/pup
6262

6363
![Metrics marker](/.github/readme/imgs/about_metrics_marker.png)
6464

65-
Additional bonus of using pupeeter is that it can take screenshots, making it easy to convert SVGs to PNG output.
65+
Additional bonus of using puppeteer is that it can take screenshots, making it easy to convert SVGs to PNG output.
6666

6767
### 💬 Gathering external data from GitHub APIs and Third-Party services
6868

6969
*metrics* mostly use GitHub APIs since it is its primary target. Most of the time, data are retrieved through GraphQL to save APIs requests, but it sometimes fallback on REST for other features. Octokit SDKs are used to make it easier.
7070

7171
As for other external services (Twitter, Spotify, PageSpeed, ...), metrics use their respective APIs, usually making https requests through [axios](https://github.com/axios/axios) and by following their documentation. It would be overkill to install entire SDKs for these since plugins rarely uses more than 2/3 calls.
7272

73-
In last resort, pupeeter is seldom used to scrap websites, though its use tends to make things slow and unstable (as it'll break upon HTML structural changes).
73+
In last resort, puppeteer is seldom used to scrap websites, though its use tends to make things slow and unstable (as it'll break upon HTML structural changes).
7474

7575
### 💬 Web instance and GitHub action similarities
7676

‎CODE_OF_CONDUCT.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
We as members, contributors, and leaders pledge to make participation in our
66
community a harassment-free experience for everyone, regardless of age, body
77
size, visible or invisible disability, ethnicity, sex characteristics, gender
8-
identity and expression, level of experience, education, socio-economic status,
8+
identity and expression, level of experience, education, socioeconomic status,
99
nationality, personal appearance, race, religion, or sexual identity
1010
and orientation.
1111

‎CONTRIBUTING.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The following contributions are accepted:
2020
<table>
2121
<tr>
2222
<th>Section</th>
23-
<th>Editions</th>
23+
<th>Changes</th>
2424
<th>Additions</th>
2525
<th>Notes</th>
2626
</tr>
@@ -41,7 +41,7 @@ The following contributions are accepted:
4141
<td>❌</td>
4242
<td>
4343
<ul>
44-
<li>Templates editions are allowed with new features additions (but must remain consistent with current visuals)</li>
44+
<li>Template changes are allowed with new features additions (but must remain consistent with current visuals)</li>
4545
<li>New templates should use <a href="https://github.com/lowlighter/metrics/blob/master/source/templates/community/README.md">📕 Community templates</a> instead</li>
4646
</ul>
4747
</td>
@@ -73,7 +73,7 @@ The following contributions are accepted:
7373
<td>❌</td>
7474
<td>
7575
<ul>
76-
<li>Core editions impact all rendering process and should be avoided unless necessary</li>
76+
<li>Core changes impact all rendering process and should be avoided unless necessary</li>
7777
<li>New dependencies should be avoided when possible</li>
7878
</ul>
7979
</td>

‎README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 📊 Metrics [<img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=280144&theme=dark" alt="" align="right" width="190" height="41">](https://www.producthunt.com/posts/github-metrics?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-github-metrics)
1+
# 📊 Metrics [<img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=280144&theme=dark" alt="" align="right" width="190" height="41">](https://www.producthunt.com/posts/github-metrics?utm_source=badge-featured&utm_medium=badge&utm_source=badge-github-metrics)
22

33
[![Continuous integration](https://github.com/lowlighter/metrics/actions/workflows/ci.yml/badge.svg)](https://github.com/lowlighter/metrics/actions/workflows/ci.yml)
44

@@ -84,7 +84,7 @@ Generate metrics that can be embedded everywhere, including your GitHub profile
8484
</td>
8585
<td align="center">
8686
<details open><summary>Recent activity charts</summary><img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.habits.charts.svg" alt=""></img></details>
87-
<details open><summary>Midly interesting facts</summary><img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.habits.facts.svg" alt=""></img></details>
87+
<details open><summary>Mildly interesting facts</summary><img alt="" width="400" src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.habits.facts.svg" alt=""></img></details>
8888
<img width="900" height="1" alt="">
8989
</td>
9090
</tr>
@@ -408,7 +408,7 @@ Plugins provide additional content and lets you customize rendered metrics.
408408
* **Core plugins**
409409
* [🗃️ Base content <sub>`base`</sub>](/source/plugins/base/README.md)
410410
* [🧱 Core <sub>`core`</sub>](/source/plugins/core/README.md)
411-
* **Github plugins**
411+
* **GitHub plugins**
412412
* [🏆 Achievements <sub>`achievements`</sub>](/source/plugins/achievements/README.md)
413413
* [📰 Recent activity <sub>`activity`</sub>](/source/plugins/activity/README.md)
414414
* [📆 Commit calendar <sub>`calendar`</sub>](/source/plugins/calendar/README.md)

‎action.yml

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎source/app/action/index.mjs

+6-6
Original file line numberDiff line numberDiff line change
@@ -176,11 +176,11 @@ function quit(reason) {
176176
const api = {}
177177
const resources = {}
178178
api.graphql = octokit.graphql.defaults({headers: {authorization: `token ${token}`}})
179-
info("Github GraphQL API", "ok")
179+
info("GitHub GraphQL API", "ok")
180180
const octoraw = github.getOctokit(token)
181181
api.rest = octoraw.rest
182182
api.rest.request = octoraw.request
183-
info("Github REST API", "ok")
183+
info("GitHub REST API", "ok")
184184
//Apply mocking if needed
185185
if (mocked) {
186186
Object.assign(api, await mocks(api))
@@ -397,7 +397,7 @@ function quit(reason) {
397397
let rendered = await retry(async () => {
398398
const {rendered, errors} = await metrics({login: user, q}, {graphql, rest, plugins, conf, die, verify, convert}, {Plugins, Templates})
399399
if (errors.length) {
400-
console.warn(`::group::${errors.length} error(s) occured`)
400+
console.warn(`::group::${errors.length} error(s) occurred`)
401401
console.warn(util.inspect(errors, {depth: Infinity, maxStringLength: 256}))
402402
console.warn("::endgroup::")
403403
}
@@ -459,7 +459,7 @@ function quit(reason) {
459459
else {
460460
//Cache embed svg for markdown outputs
461461
if (/markdown/.test(convert)) {
462-
const regex = /(?<match><img class="metrics-cachable" data-name="(?<name>[\s\S]+?)" src="data:image[/](?<format>(?:svg[+]xml)|jpeg|png);base64,(?<content>[/+=\w]+?)">)/
462+
const regex = /(?<match><img class="metrics-cacheable" data-name="(?<name>[\s\S]+?)" src="data:image[/](?<format>(?:svg[+]xml)|jpeg|png);base64,(?<content>[/+=\w]+?)">)/
463463
let matched = null
464464
while (matched = regex.exec(rendered)?.groups) { //eslint-disable-line no-cond-assign
465465
await retry(async () => {
@@ -499,7 +499,7 @@ function quit(reason) {
499499
}
500500
}
501501

502-
//Check editions
502+
//Check changes
503503
if ((committer.commit) || (committer.pr)) {
504504
const git = sgit()
505505
const sha = await git.hashObject(paths.join("/renders", filename))
@@ -690,7 +690,7 @@ function quit(reason) {
690690
console.error(error)
691691
//Print debug buffer if debug was not enabled (if it is, it's already logged on the fly)
692692
if (!DEBUG) {
693-
for (const log of [info.break(), "An error occured, logging debug message :", ...debugged])
693+
for (const log of [info.break(), "An error occurred, logging debug message :", ...debugged])
694694
console.log(log)
695695
}
696696
core.setFailed(error.message)

‎source/app/metrics/index.mjs

+3-3
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ export default async function metrics({login, q}, {graphql, rest, plugins, conf,
6868
if (errors.length) {
6969
console.debug(`metrics/compute/${login} > ${errors.length} errors !`)
7070
if (die)
71-
throw new Error("An error occured during rendering, dying")
71+
throw new Error("An error occurred during rendering, dying")
7272
else
7373
console.debug(util.inspect(errors, {depth: Infinity, maxStringLength: 256}))
7474
}
@@ -117,7 +117,7 @@ export default async function metrics({login, q}, {graphql, rest, plugins, conf,
117117
console.debug(`metrics/compute/${login}/embed > ${name} >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>`)
118118
if ((!name) || (typeof q !== "object") || (q === null)) {
119119
if (die)
120-
throw new Error("An error occured during embed rendering, dying")
120+
throw new Error("An error occurred during embed rendering, dying")
121121
return "<p>⚠️ Failed to execute embed function: invalid arguments</p>"
122122
}
123123
console.debug(`metrics/compute/${login} > embed called with`)
@@ -142,7 +142,7 @@ export default async function metrics({login, q}, {graphql, rest, plugins, conf,
142142
//Compute rendering
143143
const {rendered} = await metrics({login, q}, {...arguments[1], convert: ["svg", "png", "jpeg"].includes(q["config.output"]) ? q["config.output"] : null}, arguments[2])
144144
console.debug(`metrics/compute/${login}/embed > ${name} > success >>>>>>>>>>>>>>>>>>>>>>`)
145-
return `<img class="metrics-cachable" data-name="${name}" src="data:image/${{png: "png", jpeg: "jpeg"}[q["config.output"]] ?? "svg+xml"};base64,${Buffer.from(rendered).toString("base64")}">`
145+
return `<img class="metrics-cacheable" data-name="${name}" src="data:image/${{png: "png", jpeg: "jpeg"}[q["config.output"]] ?? "svg+xml"};base64,${Buffer.from(rendered).toString("base64")}">`
146146
}
147147
//Rendering template source
148148
let rendered = source.replace(/\{\{ (?<content>[\s\S]*?) \}\}/g, "{%= $<content> %}")

‎source/app/metrics/presets.mjs

+1-1
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ export default async function presets(list, {log = true, core = null} = {}) {
6363
catch (error) {
6464
if (env === "action")
6565
console.log(`::warning::skipping preset ${file}: ${error.message}`)
66-
logger(`metrics/presets > an error occured while loading preset ${file} (${error}), ignoring`)
66+
logger(`metrics/presets > an error occurred while loading preset ${file} (${error}), ignoring`)
6767
}
6868
}
6969
return options

‎source/app/metrics/utils.mjs

+4-4
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@ export async function spawn(command, args = [], options = {}, {prefixed = true,
269269
})
270270
}
271271

272-
/**Check command existance */
272+
/**Check command existence */
273273
export async function which(command) {
274274
try {
275275
console.debug(`metrics/command > checking existence of ${command}`)
@@ -282,7 +282,7 @@ export async function which(command) {
282282
return false
283283
}
284284

285-
/**Code hightlighter */
285+
/**Code highlighter */
286286
export function highlight(code, lang) {
287287
return lang in prism.languages ? prism.highlight(code, prism.languages[lang]) : code
288288
}
@@ -479,7 +479,7 @@ export const svg = {
479479
console.debug("metrics/svg/resize > successfully executed user javascript")
480480
}
481481
catch (error) {
482-
console.debug(`an error occured while evaluating script: ${error}`)
482+
console.debug(`an error occurred while evaluating script: ${error}`)
483483
}
484484
}
485485
//Disable animations
@@ -510,7 +510,7 @@ export const svg = {
510510
))
511511
}
512512
catch (error) {
513-
console.debug(`metrics/svg/resize > an error occured: ${error}`)
513+
console.debug(`metrics/svg/resize > an error occurred: ${error}`)
514514
throw error
515515
}
516516
//Convert if required

‎source/app/web/statics/embed/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@
6969
<small>{{ requests.rest.remaining }} REST / {{ requests.graphql.remaining }} GraphQL / {{ requests.search.remaining }} search</small>
7070
<small class="warning" v-if="preview">
7171
Metrics are rendered by <a href="https://metrics.lecoq.io/">metrics.lecoq.io</a> in preview mode.
72-
Any backend editions won't be reflected but client-side rendering can still be tested.
72+
Any backend changes won't be reflected but client-side rendering can still be tested.
7373
</small>
7474
<div class="warning" v-if="unusable.length">
7575
The following plugins options are not available on this web instance: {{ unusable.join(", ") }}

‎source/app/web/statics/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ <h2>
7676
<div class="about">
7777
<small class="warning mb1" v-if="preview">
7878
Metrics are rendered by <a href="https://metrics.lecoq.io/">metrics.lecoq.io</a> in preview mode.<br>
79-
Any backend editions won't be reflected but client-side rendering can still be tested.
79+
Any backend changes won't be reflected but client-side rendering can still be tested.
8080
</small>
8181
<div class="warning mb1" v-if="(!requests.rest.remaining)||(!requests.graphql.remaining)">
8282
This web instance has run out of GitHub API requests.

‎source/app/web/statics/insights/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ <h2>
7979
</div>
8080
<small class="warning" v-if="preview">
8181
Metrics insights are rendered by <a href="https://metrics.lecoq.io/">metrics.lecoq.io</a> in preview mode.<br>
82-
Any backend editions won't be reflected but client-side rendering can still be tested.
82+
Any backend changes won't be reflected but client-side rendering can still be tested.
8383
</small>
8484
</section>
8585

‎source/plugins/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Plugins provide additional content and lets you customize rendered metrics.
77
* **Core plugins**
88
* [🗃️ Base content <sub>`base`</sub>](/source/plugins/base/README.md)
99
* [🧱 Core <sub>`core`</sub>](/source/plugins/core/README.md)
10-
* **Github plugins**
10+
* **GitHub plugins**
1111
* [🏆 Achievements <sub>`achievements`</sub>](/source/plugins/achievements/README.md)
1212
* [📰 Recent activity <sub>`activity`</sub>](/source/plugins/activity/README.md)
1313
* [📆 Commit calendar <sub>`calendar`</sub>](/source/plugins/calendar/README.md)

0 commit comments

Comments
 (0)