jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-20 10:28:40 -05:00
Code Issues Projects Releases Wiki Activity

Add additional search-replace rules and tests (#42826)

Browse Source 
Co-authored-by: Peter Bengtsson <peterbe@github.com>
This commit is contained in:
Rachael Sewell
2023-09-22 11:12:49 -07:00
committed by GitHub
parent 72c5f0c30e
commit 4819fa2ec7
5 changed files with 159 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

63
src/content-linter/style/github-docs.js
View File

@@ -48,12 +48,15 @@ export const githubDocsConfig = {
severity: 'error',
'partial-markdown-files': true,
},
}
export const searchReplaceConfig = {
'search-replace': {
rules: [
{
name: 'todocs-placeholder',
message: 'Catch occurrences of TODOCS placeholder.',
search: 'TODOCS',
searchPattern: '/todocs/gi',
searchScope: 'all',
severity: 'error',
'severity-local': 'warning',
@@ -62,7 +65,7 @@ export const githubDocsConfig = {
{
name: 'docs-domain',
message: 'Catch occurrences of docs.gitub.com domain.',
search: 'docs.gitub.com',
search: 'docs.github.com',
searchScope: 'all',
severity: 'error',
'partial-markdown-files': true,
@@ -90,11 +93,65 @@ export const githubDocsConfig = {
// developer.github.com/enterprise/[0-9] or
// developer.github.com/enterprise/{{something}} (e.g. liquid).
// There are occurences that will likely always remain in the content.
searchPattern: '/developer.github.com(?!/(changes|enterprise/([0-9]|{))).*/g',
searchPattern: '/developer\\.github\\.com(?!\\/(changes|enterprise\\/([0-9]|{))).*/g',
searchScope: 'all',
severity: 'error',
'partial-markdown-files': true,
},
{
// Catches usage of old liquid data reusable syntax. For example:
// {{ site.data.variables.product_releases }}
name: 'deprecated liquid syntax: site.data',
message: 'Catch occurrences of deprecated liquid data syntax.',
searchPattern: '/{{\\s*?site\\.data\\.([a-zA-Z0-9-_]+(?:\\.[a-zA-Z0-9-_]+)+)\\s*?}}/g',
replace: '{% data $1 %}',
},
{
// Catches usage of old octicon variable syntax. For example:
// - {{ octicon-plus }}
// - {{ octicon-plus An example label }}
name: 'deprecated liquid syntax: octicon-<icon-name>',
message:
'The octicon liquid syntax used is deprecated. Use this format instead {% octicon "<octicon-name>" aria-label="<Octicon aria label>" %}',
searchPattern: '/{{\\s*?octicon-([a-z-]+)(\\s[\\w\\s\\d-]+)?\\s*?}}/g',
},
{
// Catches usage of string personal access token, which should
// be replaced with a reusable data variable.
name: 'personal access token reusable',
message:
'The string "personal access token" can be replaced with a variable. You should use one of the variables from data/variables/product.yml instead of the literal phrase(s):',
searchPattern: '/personal access tokens?/gi',
},
{
// Catches usage of GitHub-owned actions that don't use a
// resuable.
// GitHub-owned actions (e.g. actions/checkout@v2) should use a
// reusable in examples.
//
// - actions/checkout@v2
// - actions/delete-package-versions@v2
// - actions/download-artifact@v2
// - actions/upload-artifact@v2
// - actions/github-script@v2
// - actions/setup-dotnet@v2
// - actions/setup-go@v2
// - actions/setup-java@v2
// - actions/setup-node@v2
// - actions/setup-python@v2
// - actions/stale@v2
// - actions/cache@v2
// - github/codeql-action/init@v2
// - github/codeql-action/analyze@v2
// - github/codeql-action/autobuild@v2
// - github/codeql-action/upload-sarif@v2
//
name: 'GitHub-owned action references should use a reusable',
message:
'A GitHub-owned action is referenced, but should be replaced with a reusable from data/reusables/actions.',
searchPattern:
'/(actions\\/(checkout|delete-package-versions|download-artifact|upload-artifact|github-script|setup-dotnet|setup-go|setup-java|setup-node|setup-python|stale|cache)|github\\/codeql-action[/a-zA-Z-]*)/g',
},
],
},
}