Skip to content

Commit ee01749

Browse files
chore(sync): 🔨 synced file(s) with dp-next/wp1-ros
1 parent 3735b88 commit ee01749

5 files changed

Lines changed: 71 additions & 103 deletions

File tree

.editorconfig

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,12 @@ root = true
66
[*]
77
charset = utf-8
88
indent_style = space
9-
indent_size = 4
9+
indent_size = 2
1010
end_of_line = lf
1111
insert_final_newline = true
1212
trim_trailing_whitespace = true
13-
max_line_length = 72
1413

15-
[*.{yaml,yml}]
16-
indent_size = 2
14+
# Have a bit shorter line length for text docs
15+
[*.{txt,md,qmd}]
16+
max_line_length = 72
17+
indent_size = 4

.vscode/extensions.json

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
{
2-
// See https://go.microsoft.com/fwlink/?LinkId=827846 to learn about workspace recommendations.
3-
// Extension identifier format: ${publisher}.${name}. Example: vscode.csharp
4-
// List of extensions which should be recommended for users of this workspace.
52
"recommendations": [
6-
"jebbs.plantuml",
3+
"eamodio.gitlens",
4+
"github.vscode-github-actions",
5+
"redhat.vscode-yaml",
76
"donjayamanne.githistory",
87
"felipecaputo.git-project-manager",
98
"GitHub.vscode-pull-request-github",
10-
"quarto.quarto",
11-
"streetsidesoftware.code-spell-checker",
129
"vivaxy.vscode-conventional-commits",
13-
"pshaddel.conventional-branch"
10+
"quarto.quarto",
11+
"pshaddel.conventional-branch",
12+
"EditorConfig.EditorConfig",
13+
"tekumara.typos-vscode",
1414
],
1515
// List of extensions recommended by VS Code that should not be recommended for users of this workspace.
1616
"unwantedRecommendations": []

.vscode/json.code-snippets

Lines changed: 6 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
{
2-
// Place your snippets for Quarto here.
3-
// Each snippet is defined under a snippet name and has a prefix, body and description.
4-
// The prefix is what is used to trigger the snippet and the body will be expanded and inserted.
2+
// Place your snippets for Quarto here.
3+
// Each snippet is defined under a snippet name and has a prefix, body and description.
4+
// The prefix is what is used to trigger the snippet and the body will be expanded and inserted.
55
// Possible variables are:
66
//
7-
// - $1 and $2 for tab stops,
8-
// - $0 for the final cursor position, and
7+
// - $1 and $2 for tab stops,
8+
// - $0 for the final cursor position, and
99
// - ${1:label}, ${2:another} for placeholders
10-
//
10+
//
1111
// Placeholders with the same ids are connected.
1212
//
1313
// How to use the code snippets:
@@ -31,21 +31,6 @@
3131
],
3232
"description": "Insert bash formatted text"
3333
},
34-
"Insert YAML header for blogs": {
35-
"scope": "quarto,markdown",
36-
"prefix": "post_yaml",
37-
"body": [
38-
"---",
39-
"title: \"\"",
40-
"description: \"Our reasons for ...\"",
41-
"author: \"\"",
42-
"date: last-modified",
43-
"categories:",
44-
" ${0:Type 'category_keywords' to insert categories}",
45-
"---"
46-
],
47-
"description": "Insert YAML header for Quarto blog posts."
48-
},
4934
"Insert a hidden comment section": {
5035
"scope": "quarto,markdown",
5136
"prefix": "hidden",
@@ -76,14 +61,6 @@
7661
],
7762
"description": "Insert a 3 col table"
7863
},
79-
"Insert video": {
80-
"scope": "quarto,markdown",
81-
"prefix": "video",
82-
"body": [
83-
"{{< video ${0:Insert link here} >}}"
84-
],
85-
"description": "Insert video that will be shown"
86-
},
8764
"Insert paneltab": {
8865
"scope": "quarto,markdown",
8966
"prefix": "paneltab",
@@ -99,39 +76,5 @@
9976
":::"
10077
],
10178
"description": "Insert paneltab (including two tabs here). If you want additional tabs, just include more headers."
102-
},
103-
// All our category words are included in this code snippet
104-
// The idea is that we can insert this section and then delete the words we aren't interested in
105-
// If words are missing then they can be added to the document, and then also added to the code snippet
106-
// Much the same way that words can be added to the spell-check extension.
107-
"Insert list of category words": {
108-
"scope": "quarto,markdown,yaml",
109-
"prefix": "decision_categories",
110-
"body": [
111-
"- backend",
112-
"- code snippets",
113-
"- communicate",
114-
"- container",
115-
"- contribute",
116-
"- collaborate",
117-
"- database",
118-
"- deploy",
119-
"- dependencies",
120-
"- develop",
121-
"- document",
122-
"- front end",
123-
"- framework",
124-
"- git",
125-
"- install",
126-
"- license",
127-
"- manage",
128-
"- organize",
129-
"- standardise",
130-
"- style",
131-
"- web",
132-
"- workflow",
133-
"- write"
134-
],
135-
"description": "Insert list of category words"
13679
}
13780
}

.vscode/settings.json

Lines changed: 23 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,26 @@
11
{
2-
"files.autoSave": "onFocusChange",
3-
"editor.wordWrap": "on",
2+
"files.autoSave": "onFocusChange",
3+
"editor.wordWrap": "off",
4+
"editor.formatOnSave": true,
5+
"git.autofetch": false,
6+
"quarto.visualEditor.markdownWrap": "column",
7+
"quarto.visualEditor.markdownWrapColumn": 72,
8+
"editor.tabCompletion": "on",
9+
"editor.snippetSuggestions": "inline",
10+
"conventional-branch.type": [
11+
"build", // Changes that affect the build system or external dependencies
12+
"ci", // Changes to our CI configuration files and scripts
13+
"docs", // Documentation only changes
14+
"feat", // A new feature
15+
"fix", // A bug fix
16+
"refactor", // A code change that neither fixes a bug nor adds a feature
17+
"style", // Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
18+
"test", // Adding missing tests or correcting existing tests
19+
"chore", // Misc things, like renaming or deleting files
20+
],
21+
"conventional-branch.format": "{Type}/{Branch}",
22+
"files.insertFinalNewline": true,
23+
"[quarto,markdown]": {
424
"editor.formatOnSave": false,
5-
"git.autofetch": false,
6-
"quarto.visualEditor.markdownWrap": "column",
7-
"quarto.visualEditor.markdownWrapColumn": 72,
8-
"editor.tabCompletion": "on",
9-
"editor.snippetSuggestions": "inline",
10-
"conventional-branch.type": [
11-
"build", // Changes that affect the build system or external dependencies
12-
"ci", // Changes to our CI configuration files and scripts
13-
"docs", // Documentation only changes
14-
"feat", // A new feature
15-
"fix", // A bug fix
16-
"refactor", // A code change that neither fixes a bug nor adds a feature
17-
"style", // Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
18-
"test", // Adding missing tests or correcting existing tests
19-
"chore", // Misc things, like renaming or deleting files
20-
],
21-
"conventional-branch.format": "{Type}/{Branch}",
22-
"files.insertFinalNewline": true,
23-
"cSpell.enabledFileTypes": {
24-
"quarto": true
25-
},
26-
"cSpell.language": "en,en-GB",
25+
},
2726
}

justfile

Lines changed: 30 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,38 @@
11
@_default:
22
just --list --unsorted
33

4-
# Run all recipes
5-
run-all: build-website
4+
# Run all necessary build commands.
5+
run-all: check-spelling check-commits build-website build-readme
66

7-
# Generate PNG images from PlantUML files
8-
generate-puml:
9-
docker run --rm -v $(pwd):/puml -w /puml ghcr.io/plantuml/plantuml:latest -tsvg "**/*.puml"
7+
# Install the pre-commit hooks
8+
install-precommit:
9+
# Install pre-commit hooks
10+
uvx pre-commit install
11+
# Run pre-commit hooks on all files
12+
uvx pre-commit run --all-files
13+
# Update versions of pre-commit hooks
14+
uvx pre-commit autoupdate
15+
16+
# Check spelling
17+
check-spelling:
18+
uvx typos
19+
20+
# Run checks on all commits made on the current branch up to the main branch
21+
check-commits:
22+
#!/bin/zsh
23+
branch_name=$(git rev-parse --abbrev-ref HEAD)
24+
number_of_commits=$(git rev-list --count HEAD ^main)
25+
if [[ ${branch_name} != "main" && ${number_of_commits} -gt 0 ]]
26+
then
27+
uvx --from commitizen cz check --rev-range main..HEAD
28+
else
29+
echo "Can't either be on ${branch_name} or have more than ${number_of_commits}."
30+
fi
1031

1132
# Build the website using Quarto
1233
build-website:
1334
quarto render
35+
36+
# Re-build the README file
37+
build-readme:
38+
quarto render README.qmd --to gfm

0 commit comments

Comments
 (0)