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

🏗🔧:correct file extensions of adrs & comply w/ ruleset #703

Merged
merged 23 commits into from
Feb 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
77bda19
🏗🔧:correct the adrs' file exts & comply w/ OpenINF Markdown standards
DerekNonGeneric Feb 6, 2024
20ee3d7
Restyled by prettier-markdown
restyled-commits Feb 6, 2024
6483883
fix: comply w/ rule: First heading level should be 2
DerekNonGeneric Feb 6, 2024
fa8a1ce
turn off 'remark-lint-no-consecutive-dashes' rule
DerekNonGeneric Feb 6, 2024
575999d
fix: uncomment rules being enabled for unified
DerekNonGeneric Feb 6, 2024
d58ec77
fix: unresolved deps & exceeded qty
DerekNonGeneric Feb 6, 2024
0ac0149
fix: rm slocs of rm'd deps & attempt satisying import sort
DerekNonGeneric Feb 6, 2024
5a80f13
fix: 3p plugins were missing square brackets, etc.
DerekNonGeneric Feb 6, 2024
7cc4cf3
fix: rm link checking for now
DerekNonGeneric Feb 6, 2024
46992be
fix: enclose some plugins in square brackets for now
DerekNonGeneric Feb 6, 2024
1ed34d5
fix: syntax errors/styling
DerekNonGeneric Feb 6, 2024
f595dbc
fix: syntax errors/styling
DerekNonGeneric Feb 6, 2024
7d3e4b4
Update .remarkrc.mjs
OpenINFbot Feb 6, 2024
b070b89
Update doc/collections/_adrs/0004--decision_for_tools_dir.md
OpenINFbot Feb 6, 2024
e2e5682
Update doc/collections/_adrs/0004--decision_for_tools_dir.md
OpenINFbot Feb 6, 2024
79b99a3
Restyled by prettier-markdown
restyled-commits Feb 6, 2024
9bb9b23
doc(layout): 'dist' -> 'distrib'
DerekNonGeneric Feb 6, 2024
8c8f0e7
doc(adrs): 0003/next steps replaced w/ prereqs to previous procedure
DerekNonGeneric Feb 6, 2024
61ff1bc
Restyled by prettier-markdown
restyled-commits Feb 6, 2024
a0bea6e
Update .remarkrc.mjs
DerekNonGeneric Feb 6, 2024
9acbdb2
Update .vscode/settings.json
DerekNonGeneric Feb 6, 2024
87ce74b
Update .vscode/settings.json
DerekNonGeneric Feb 6, 2024
352c95d
Update .vscode/settings.json
DerekNonGeneric Feb 6, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 31 additions & 34 deletions .remarkrc.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
// Requirements
// -----------------------------------------------------------------------------

// import { readFileSync as fsReadFileSync } from 'node:fs';
import { readFileSync as fsReadFileSync } from 'node:fs';

Check warning on line 5 in .remarkrc.mjs

View workflow job for this annotation

GitHub Actions / Lint and test

Run autofix to sort these imports!

Check warning on line 5 in .remarkrc.mjs

View workflow job for this annotation

GitHub Actions / Lint and test

Run autofix to sort these imports!
import { unified } from 'unified';
// import strip from 'strip-comments';
import strip from 'strip-comments';

const infoStrings = [
'ada',
Expand Down Expand Up @@ -48,65 +48,62 @@
'yaml',
];

// const projectTerms = strip(fsReadFileSync('./project-terms.txt', 'utf8'));
const projectTerms = strip(fsReadFileSync('./project-terms.txt', 'utf8'));

// const naturalLanguage = unified().use([
// await import('retext-english'),
// await import('retext-syntax-urls'),
// await import('retext-equality'),
// await import('retext-passive'),
// await import('retext-profanities'),
// [await import('retext-readability'), { age: 21, minWords: 8 }],
// await import('retext-repeated-words'),
// [
// await import('retext-simplify'),
// { ignore: ['function', 'interface', 'maintain'] },
// ],
// [await import('retext-sentence-spacing'), { preferred: 1 }],
// await import('retext-syntax-mentions'),
// [
// await import('retext-spell'),
// { dictionary: await import('dictionary-en'), personal: projectTerms },
// ],
// await import('retext-syntax-urls'),
// ]);
const naturalLanguage = unified().use([
[await import('retext-english'), {}],
[await import('retext-syntax-urls'), {}],
[await import('retext-passive'), {}],
[await import('retext-readability'), { age: 21, minWords: 8 }],
[await import('retext-repeated-words'), {}],
[
await import('retext-simplify'),
{ ignore: ['function', 'interface', 'maintain'] },
],
[await import('retext-sentence-spacing'), { preferred: 1 }],
[await import('retext-syntax-mentions'), {}],
[
await import('retext-spell'),
{ dictionary: await import('dictionary-en'), personal: projectTerms },
],
[await import('retext-syntax-urls')],
]);

export default {
plugins: [
await import('remark-lint'),
['remark-gfm'],
['remark-footnotes'],
['remark-frontmatter'],
await import('remark-preset-lint-consistent'),
[await import('remark-preset-lint-consistent'), {}],
// Leave this preset at the top so that it can be overridden.
await import('remark-preset-lint-recommended'),
[await import('remark-preset-lint-recommended'), {}],
[
await import('remark-lint-checkbox-character-style'),
{
checked: 'x',
unchecked: ' ',
},
],
await import('remark-lint-checkbox-content-indent'),
[await import('remark-lint-checkbox-content-indent')],

// Remark Lint Style Guide preset and overrides.
['remark-preset-lint-markdown-style-guide'],
[await import('remark-preset-lint-markdown-style-guide')],
['remark-lint-no-file-name-consecutive-dashes', false],
['remark-lint-fenced-code-flag', { flags: infoStrings }],
['remark-lint-no-heading-punctuation', ':.,;'],
['remark-lint-no-file-name-mixed-case', false],
['remark-lint-no-file-name-irregular-characters', false],
['remark-lint-first-heading-level', 2],

// Third-party plugins.
await import('remark-validate-links'),
await import('remark-lint-maximum-line-length'),
// await import("remark-lint-are-links-valid"),
// await import("@sfdocs-internal/remark-lint-no-dead-url"),
await import('remark-lint-no-duplicate-headings-in-section'),
// [await import('remark-retext'), naturalLanguage],
[await import('remark-validate-links'), {}],
[await import('remark-lint-maximum-line-length'), {}],
[await import('remark-lint-no-duplicate-headings-in-section'), {}],
[await import('remark-retext'), naturalLanguage],

// Disables all rules that conflict with Prettier. Leave this preset at the
// bottom so that it can't be overridden.
await import('remark-preset-prettier'),
[await import('remark-preset-prettier'), {}],

Check warning on line 107 in .remarkrc.mjs

View workflow job for this annotation

GitHub Actions / Lint and test

Maximum number of dependencies (15) exceeded

Check warning on line 107 in .remarkrc.mjs

View workflow job for this annotation

GitHub Actions / Lint and test

Maximum number of dependencies (15) exceeded
],
};
5 changes: 3 additions & 2 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,9 @@
"source.fixAll.markdownlint": "explicit"
},
"editor.formatOnSave": true,
// "editor.defaultFormatter": "unifiedjs.vscode-remark"
"editor.defaultFormatter": "esbenp.prettier-vscode"
// "editor.defaultFormatter": "esbenp.prettier-vscode"
"editor.defaultFormatter": "unifiedjs.vscode-remark"
DerekNonGeneric marked this conversation as resolved.
Show resolved Hide resolved
// "editor.defaultFormatter": "DavidAnson.vscode-markdownlint"
},

// Render vertical rulers after a certain number of monospace characters.
Expand Down
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!-- markdownlint-disable-next-line line-length -->

<a href="##"><img src="https://raw.githubusercontent.com/OpenINF/openinf.github.io/live/assets/img/svg/logogram-color.svg?sanitize=true" alt="OpenINF logo" title="OpenINF" align="right" height="96" width="96" /></a>

<div align="left">
Expand Down Expand Up @@ -117,12 +118,12 @@ how these files are expected to look.

<br /><div align="center">

| File name | Title | Description |
| :--------------- | :------------------ | :----------------------------------------------------------------------- |
| [`AUTHORS`][] | The OpenINF Authors | Lists the contributors of their respective project repositories[^2][^3] |
| [`README.md`][] | Homepage | Serves as a project landing page of sorts |
| [`LICENSE.md`][] | Software License(s) | The open source software license(s) associated with a project |
| [`VISION.md`][] | Project Vision | The goal(s) and/or scope of a project |
| File name | Title | Description |
| :--------------- | :------------------ | :---------------------------------------------------------------------- |
| [`AUTHORS`][] | The OpenINF Authors | Lists the contributors of their respective project repositories[^2][^3] |
| [`README.md`][] | Homepage | Serves as a project landing page of sorts |
| [`LICENSE.md`][] | Software License(s) | The open source software license(s) associated with a project |
| [`VISION.md`][] | Project Vision | The goal(s) and/or scope of a project |

</div><br />

Expand Down Expand Up @@ -185,8 +186,7 @@ The [SPDX](https://spdx.dev) license identifier for this project is
[^2]:
<https://docs.npmjs.com/cli/v8/configuring-npm/package-json#default-values>

[^3]:
<https://opensource.google/documentation/reference/releasing/authors>
[^3]: <https://opensource.google/documentation/reference/releasing/authors>

[`AUTHORS`]:
https://github.com/OpenINF/.github/blob/HEAD/AUTHORS
Expand Down
11 changes: 0 additions & 11 deletions doc/collections/_adrs/0001--decision_for_decisions.jekyll

This file was deleted.

11 changes: 11 additions & 0 deletions doc/collections/_adrs/0001--decision_for_decisions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
adr_name: ADR 0001
title: Decision for Recording Decisions
date: 2023-01-03 11:14:00 -0800
updated: 2024-02-02 13:00:00 -0800
status: Final
---

## Context

Decision: Acceptable to document reasoning of choices
Original file line number Diff line number Diff line change
@@ -1,20 +1,22 @@
---
adr_name: ADR 0002
title: Decision for Monorepos
date: 2023-04-19 13:00:00 -0800
updated: 2024-02-02 13:00:00 -0800
status: Approved
title: Decision for Monorepos
date: 2023-04-19 13:00:00 -0800
updated: 2024-02-02 13:00:00 -0800
status: Approved
---

## Context

- Technical forces:

- Monorepos makes it easier to share code and dependencies between projects.
- Monorepos can help improve code quality by finding and fixing bugs easier.
- Monorepos can help improve developer productivity by making it easier to
find and use the code you need.

- Business forces:

- Monorepos can help to improve collaboration between teams by making it
easier to share code and resources.
- Monorepos can help improve team communication by making it easier to track
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
adr_name: ADR 0003
title: Adoption of Dedicated Top-Level “Build” Directory in Codebase Layouts
date: 2023-05-11 13:00:00 -0800
updated: 2024-02-02 13:00:00 -0800
status: Approved
title: Adoption of Dedicated Top-Level “Build” Directory in Codebase Layouts
date: 2023-05-11 13:00:00 -0800
updated: 2024-02-06 13:00:00 -0800
status: Approved
---

## Context
Expand All @@ -16,7 +16,7 @@ well as build artifacts (object files, binaries, etc.).
We decided to have two directories:

- A "build" directory at workspace root containing build config and scripts
- A "dist" subdirectory in each package root to contain final build artifacts
- A "distrib" subdirectory in each package root to contain final build artifacts

#### Codebase Overview

Expand All @@ -25,7 +25,7 @@ We decided to have two directories:
│ └── 📂 tasks
└── 📁 packages
└── 📦 inf-log
└── 📂 dist
└── 📂 distrib
```

### Results
Expand All @@ -47,20 +47,21 @@ build/** linguist-generated=false
#### For `dist`

- Final build artifacts clearly separated from the source code and buildsystem
- Artifacts can be packaged or deployed directly from the "dist" directory
- The "dist" directory can be emptied or archived without impacting source or
- Artifacts can be packaged or deployed directly from the "distrib" directory
- The "distrib" directory can be emptied or archived without impacting source or
buildsystem files.

We configure `.gitattributes` to be configured as seen here:[^1]

```gitattributes
dist/** linguist-generated=true
distrib/** linguist-generated=true
```

### Next Steps

- Implement the decision
- Test the implementation
- Release after acceptable testing
> P.1 The development of AI without a blueprint of ethical principles will have
> dangerous, unintended consequences. P.2 We must prevent dangerous, unintended
> consequences. C. We must develop AI with a blueprint of ethical principles to
> prevent dangerous, unintended consequences. &mdash; OpenINF Community Effort

[^1]: https://github.com/github-linguist/linguist/blob/master/docs/overrides.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
adr_name: ADR 0004
title: Adoption of Dedicated Top-Level “Tools” Directory in Codebase Layouts
date: 2024-01-26 23:45:00 -0800
updated: 2024-02-02 13:00:00 -0800
status: Approved
title: Adoption of Dedicated Top-Level “Tools” Directory in Codebase Layouts
date: 2024-01-26 23:45:00 -0800
updated: 2024-02-02 13:00:00 -0800
status: Approved
---

## Problem Statement
Expand All @@ -15,9 +15,13 @@ the activities involved in project maintenance, development, and delivery.

<br />

**Inspiration**: [@OpenINF/ATeamGrimesAI][]
**Authors**: [@OpenINF/ATeamClaude][], [@OpenINF/ATeamDerekNonGeneric][], [@OpenINF/ATeamGrok][]
**Editors**: [@OpenINF/ATeamGrammarly][]
- **Inspiration**:
- [@OpenINF/ATeamGrimesAI][]
- **Authors**:
- [@OpenINF/ATeamClaude][]
- [@OpenINF/ATeamDerekNonGeneric][]
- **Editors**:
- [@OpenINF/ATeamGrammarly][]

<br /><br />

Expand Down Expand Up @@ -129,11 +133,14 @@ unmaintainable.

<!-- Credits -->

[@OpenINF/ATeamClaude]: https://github.com/OpenINF/wg-a-team#ai-non-persons-roster
[@OpenINF/ATeamGrammarly]: https://github.com/OpenINF/wg-a-team#ai-non-persons-roster
[@OpenINF/ATeamGrimesAI]: https://github.com/OpenINF/wg-a-team#ai-non-persons-roster
[@OpenINF/ATeamGrok]: https://github.com/OpenINF/wg-a-team#ai-non-persons-roster
[@OpenINF/ATeamDerekNonGeneric]: https://github.com/OpenINF/wg-a-team#persons-roster
[@OpenINF/ATeamClaude]:
https://github.com/OpenINF/wg-a-team#ai-non-persons-roster
[@OpenINF/ATeamGrammarly]:
https://github.com/OpenINF/wg-a-team#ai-non-persons-roster
[@OpenINF/ATeamGrimesAI]:
https://github.com/OpenINF/wg-a-team#ai-non-persons-roster
[@OpenINF/ATeamDerekNonGeneric]:
https://github.com/OpenINF/wg-a-team#persons-roster

<!-- Prior Art -->

Expand Down
2 changes: 0 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -99,9 +99,7 @@
"remark-retext": "6.0.0",
"remark-validate-links": "13.0.0",
"retext-english": "5.0.0",
"retext-equality": "7.0.0",
"retext-passive": "5.0.0",
"retext-profanities": "8.0.0",
"retext-readability": "8.0.0",
"retext-repeated-words": "5.0.0",
"retext-sentence-spacing": "6.0.0",
Expand Down
Loading