From 35997f74f33d422fa83c603dfb417626c6b0c48f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rafa=C5=82=20Schmidt?= Date: Tue, 27 Feb 2024 22:17:50 +0100 Subject: [PATCH 1/3] feat: remove analyzers references --- .gitignore | 3 +- README.md | 161 +++++++++++---- package.json | 13 ++ .../projects/Net6SdkError/README.md | 3 +- .../projects/Net8LibWarning/README.md | 3 +- .../Allegro.DotnetSdk.csproj | 4 +- .../Allegro.NET.Sdk.CSharp.Analyzers.targets | 27 --- .../Sdk/Allegro.NET.Sdk.CSharp.targets | 11 +- yarn.lock | 185 ++++++++++++++++++ 9 files changed, 331 insertions(+), 79 deletions(-) create mode 100644 package.json delete mode 100644 src/Allegro.DotnetSdk/Sdk/Allegro.NET.Sdk.CSharp.Analyzers.targets create mode 100644 yarn.lock diff --git a/.gitignore b/.gitignore index ea39a34..f287f3d 100644 --- a/.gitignore +++ b/.gitignore @@ -23,4 +23,5 @@ BenchmarkDotNet.Artifacts paket-files/ .DS_Store .vscode/ -coverage.* \ No newline at end of file +coverage.* +node_modules/ \ No newline at end of file diff --git a/README.md b/README.md index 3ef70b9..7382603 100644 --- a/README.md +++ b/README.md @@ -2,23 +2,29 @@ ## About -The Allegro .NET SDK provides common and importable project settings, such as build properties, coding styles, analyzers configuration etc. +The Allegro .NET SDK provides common and importable project settings, such as +build properties, coding styles, analyzers configuration etc. -The SDK is versioned and published on nuget. It can be imported into dotnet projects. +The SDK is versioned and published on nuget. It can be imported into dotnet +projects. ## Using the SDK -The SDK is meant to be easily importable - only a few initial config lines are required to bring its benefits. The SDK also makes it possible to override any of its default settings. Version 2+ will work only with .NET SDK v8+. +The SDK is meant to be easily importable - only a few initial config lines are +required to bring its benefits. The SDK also makes it possible to override any +of its default settings. Version 2+ will work only with .NET SDK v8+. ## Importing The sections below list the changes required in order to import the SDK. -Additional information can be found in the docs - [Reference a project SDK](https://docs.microsoft.com/en-us/visualstudio/msbuild/how-to-use-project-sdk?view=vs-2022#reference-a-project-sdk). +Additional information can be found in the docs - +[Reference a project SDK](https://docs.microsoft.com/en-us/visualstudio/msbuild/how-to-use-project-sdk?view=vs-2022#reference-a-project-sdk). ### global.json -It's necessary to include `Allegro.DotnetSdk` with the desired version in `global.json` in the repository root: +It's necessary to include `Allegro.DotnetSdk` with the desired version in +`global.json` in the repository root: ```json { @@ -30,17 +36,18 @@ It's necessary to include `Allegro.DotnetSdk` with the desired version in `globa "Allegro.DotnetSdk": "2.1.0" } } - ``` ### Directory.Build.props -The `Directory.Build.props` file should be updated in order to actually import the SDK: +The `Directory.Build.props` file should be updated in order to actually import +the SDK: ```xml + - - + + ``` @@ -49,34 +56,43 @@ The `Directory.Build.props` file should be updated in order to actually import t Most properties are only set in the SDK if not configured by the project. -To configure the SDK, the following properties can be added into `Directory.Build.props` or `.*proj` files: - -- `AllegroDotnetSdkEnableXmlDocAdjustments` (default: true) - enable doc file generation, suppress missing-comments warning (1591) - completely in test projects, as errors otherwise (keep as warning). -- `AllegroDotnetSdkTreatWarningsAsErrors` (default: true in CI and Rider IDE) - to enable in local shell or other IDEs, just set your own user environment variable `TreatWarningsAsErrors=true`. -- `AllegroDotnetSdkEnableGlobalEditorConfig` (default: true) - add `editorconfig.global` analyzer configuration file. -- `AllegroDotnetSdkEnablePackAdjustments` (default: true) - sets PublishRepositoryUrl and enables `.snupkg` symbols. -- `AllegroDotnetSdkEnableAzureArtifactsAdjustments` (default: false) - disables `.snupkg` and instead embeds PDBs in `.nupkg`. +To configure the SDK, the following properties can be added into +`Directory.Build.props` or `.*proj` files: + +- `AllegroDotnetSdkEnableXmlDocAdjustments` (default: true) - enable doc file + generation, suppress missing-comments warning (1591) - completely in test + projects, as errors otherwise (keep as warning). +- `AllegroDotnetSdkTreatWarningsAsErrors` (default: true in CI and Rider IDE) - + to enable in local shell or other IDEs, just set your own user environment + variable `TreatWarningsAsErrors=true`. +- `AllegroDotnetSdkEnableGlobalEditorConfig` (default: true) - add + `editorconfig.global` analyzer configuration file. +- `AllegroDotnetSdkEnablePackAdjustments` (default: true) - sets + PublishRepositoryUrl and enables `.snupkg` symbols. +- `AllegroDotnetSdkEnableAzureArtifactsAdjustments` (default: false) - disables + `.snupkg` and instead embeds PDBs in `.nupkg`. For `C#` only: -- `AllegroDotnetSdkEnableImplicitUsingsAdjustments` (default: true for C#) - add `System.Collections.Immutable` and remove `Microsoft.Extensions.Logging` and `System.Net.Http` implicit usings. -- `UseAllegroDotnetSdkDefaultAnalyzers` (default: true for C# when no CPM) - reference and configure several external analyzers - StyleCop, AsyncFixer, Meziantou. -- `AllegroDotnetSdkEnableAsyncFixer` (default: `UseAllegroDotnetSdkDefaultAnalyzers`) - references AsyncFixer package. -- `AllegroDotnetSdkEnableMeziantou` (default: `UseAllegroDotnetSdkDefaultAnalyzers`) - references Meziantou.Analyzers package. -- `AllegroDotnetSdkEnableStyleCop` (default: `UseAllegroDotnetSdkDefaultAnalyzers`) - references StyleCop.Analyzers package and a preset `stylecop.json`. +- `AllegroDotnetSdkEnableImplicitUsingsAdjustments` (default: true for C#) - add + `System.Collections.Immutable` and remove `Microsoft.Extensions.Logging` and + `System.Net.Http` implicit usings. +- `AllegroDotnetSdkEnableStyleCopConfig` (default: true for C#) - references a + preset `stylecop.json`. Configure in `Directory.Build.props` - repo wide: ```xml + - + disable - false + false @@ -85,6 +101,7 @@ Configure in `Directory.Build.props` - repo wide: Configure in `*.csproj` - project settings: ```xml + @@ -95,36 +112,106 @@ Configure in `*.csproj` - project settings: ``` +## Analyzers + +This SDK exclusively specifies rules for analyzers. Avoiding direct references +ensures that developers can seamlessly apply and update analyzers without being +tied to specific versions. + +To add analyzers via CPM: + +```xml + + + ... + + + + true + true + + + + + + + + ... + +``` + +and without central package management: + +```xml + + + ... + + + + all + runtime; build; native; contentfiles; analyzers + + + + all + runtime; build; native; contentfiles; analyzers + + + + all + runtime; build; native; contentfiles; analyzers + + + ... + +``` + ## Editor config -The SDK contains a global analyzer config file containing the default configuration for various analyzers and formatters. +The SDK contains a global analyzer config file containing the default +configuration for various analyzers and formatters. -Its entries can be also overridden by entries from `.editorconfig`. Such editor config files are merged with the imported global config file. +Its entries can be also overridden by entries from `.editorconfig`. Such editor +config files are merged with the imported global config file. -More about the analyzer and editor config files can be found in [the docs](https://docs.microsoft.com/en-us/dotnet/fundamentals/code-analysis/configuration-files). +More about the analyzer and editor config files can be found in +[the docs](https://docs.microsoft.com/en-us/dotnet/fundamentals/code-analysis/configuration-files). ## IDEs support -### Rider +### Rider Make sure you have enabled: - Preferences -> Editor -> Code Style -> Enable StyleCop support (Ruleset files) - Preferences -> Editor -> Code Style -> Enable EditorConfig support -- Preferences -> Editor -> Inspection Settings -> Read settings from editorconfig, project settings and rule sets -- Preferences -> Editor -> Inspection Settings -> Roslyn -> Enable Roslyn analyzers and Source Generators -- Preferences -> Editor -> Inspection Settings -> Roslyn -> Include Roslyn analyzers in Solution-Wide Analysis - -**Be aware!** -Only some analyzers's warnings can be addressed by auto-format or code cleanup. Some of the warnings are not covered by Rider, and its settings need to be adjusted. -For that, in editor.globalconfig is `# ReSharper properties` section with some already defined settings which align with analyzers. If you find some inconsistency and you find appropriate settings in Rider, which will fix it - please, contribute! :) +- Preferences -> Editor -> Inspection Settings -> Read settings from + editorconfig, project settings and rule sets +- Preferences -> Editor -> Inspection Settings -> Roslyn -> Enable Roslyn + analyzers and Source Generators +- Preferences -> Editor -> Inspection Settings -> Roslyn -> Include Roslyn + analyzers in Solution-Wide Analysis + +**Be aware!** Only some analyzers's warnings can be addressed by auto-format or +code cleanup. Some of the warnings are not covered by Rider, and its settings +need to be adjusted. +For that, in editor.globalconfig is `# ReSharper properties` section with some +already defined settings which align with analyzers. If you find some +inconsistency and you find appropriate settings in Rider, which will fix it - +please, contribute! :) ## License Copyright Allegro Group -Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at +Licensed under the Apache License, Version 2.0 (the "License"); you may not use +this file except in compliance with the License. You may obtain a copy of the +License at -```http://www.apache.org/licenses/LICENSE-2.0``` +`http://www.apache.org/licenses/LICENSE-2.0` -Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. +Unless required by applicable law or agreed to in writing, software distributed +under the License is distributed on an " AS IS" BASIS, WITHOUT WARRANTIES OR +CONDITIONS OF ANY KIND, either express or implied. See the License for the +specific language governing permissions and limitations under the License. diff --git a/package.json b/package.json new file mode 100644 index 0000000..f4bdcb2 --- /dev/null +++ b/package.json @@ -0,0 +1,13 @@ +{ + "name": "SDK", + "devDependencies": { + "markdownlint": "^0.27.0", + "markdownlint-cli": "^0.33.0", + "prettier": "^2.8.3" + }, + "scripts": { + "format:markdown": "prettier --write \"**/**/*.md\" --prose-wrap always --parser markdown", + "format:check:markdown": "prettier --check \"**/**/*.md\" --prose-wrap always --parser markdown", + "format:lint:markdown": "markdownlint --fix --ignore node_modules --fix \"**/**/*.md\"" + } +} diff --git a/src/Allegro.DotnetSdk.Tests/projects/Net6SdkError/README.md b/src/Allegro.DotnetSdk.Tests/projects/Net6SdkError/README.md index abc7bf2..52cf5f7 100644 --- a/src/Allegro.DotnetSdk.Tests/projects/Net6SdkError/README.md +++ b/src/Allegro.DotnetSdk.Tests/projects/Net6SdkError/README.md @@ -1,3 +1,4 @@ This project should fail with an error message: -> error : Allegro.DotnetSdk requires .NET SDK v8.0.100+ to be used, but 6.0.x was found. +> error : Allegro.DotnetSdk requires .NET SDK v8.0.100+ to be used, but 6.0.x +> was found. diff --git a/src/Allegro.DotnetSdk.Tests/projects/Net8LibWarning/README.md b/src/Allegro.DotnetSdk.Tests/projects/Net8LibWarning/README.md index 02a22ea..e6e0ab8 100644 --- a/src/Allegro.DotnetSdk.Tests/projects/Net8LibWarning/README.md +++ b/src/Allegro.DotnetSdk.Tests/projects/Net8LibWarning/README.md @@ -1,3 +1,4 @@ This project should fail with an error message: -> warning CS1591: Missing XML comment for publicly visible type or member 'Class1' +> warning CS1591: Missing XML comment for publicly visible type or member +> 'Class1' diff --git a/src/Allegro.DotnetSdk/Allegro.DotnetSdk.csproj b/src/Allegro.DotnetSdk/Allegro.DotnetSdk.csproj index 65eba25..4dd2c62 100644 --- a/src/Allegro.DotnetSdk/Allegro.DotnetSdk.csproj +++ b/src/Allegro.DotnetSdk/Allegro.DotnetSdk.csproj @@ -1,8 +1,8 @@ - net6.0 - 2.1.1 + net8.0 + 2.2.0 true true true diff --git a/src/Allegro.DotnetSdk/Sdk/Allegro.NET.Sdk.CSharp.Analyzers.targets b/src/Allegro.DotnetSdk/Sdk/Allegro.NET.Sdk.CSharp.Analyzers.targets deleted file mode 100644 index eaee581..0000000 --- a/src/Allegro.DotnetSdk/Sdk/Allegro.NET.Sdk.CSharp.Analyzers.targets +++ /dev/null @@ -1,27 +0,0 @@ - - - - - - all - runtime; build; native; contentfiles; analyzers - - - - - - - all - runtime; build; native; contentfiles; analyzers - - - - - - - all - runtime; build; native; contentfiles; analyzers - - - - \ No newline at end of file diff --git a/src/Allegro.DotnetSdk/Sdk/Allegro.NET.Sdk.CSharp.targets b/src/Allegro.DotnetSdk/Sdk/Allegro.NET.Sdk.CSharp.targets index 49f4290..2f5a561 100644 --- a/src/Allegro.DotnetSdk/Sdk/Allegro.NET.Sdk.CSharp.targets +++ b/src/Allegro.DotnetSdk/Sdk/Allegro.NET.Sdk.CSharp.targets @@ -3,21 +3,14 @@ - true true - - true - true - true - - - + @@ -30,6 +23,4 @@ - - \ No newline at end of file diff --git a/yarn.lock b/yarn.lock new file mode 100644 index 0000000..721cf54 --- /dev/null +++ b/yarn.lock @@ -0,0 +1,185 @@ +# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. +# yarn lockfile v1 + + +argparse@^2.0.1: + version "2.0.1" + resolved "https://registry.yarnpkg.com/argparse/-/argparse-2.0.1.tgz#246f50f3ca78a3240f6c997e8a9bd1eac49e4b38" + integrity sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q== + +balanced-match@^1.0.0: + version "1.0.2" + resolved "https://registry.yarnpkg.com/balanced-match/-/balanced-match-1.0.2.tgz#e83e3a7e3f300b34cb9d87f615fa0cbf357690ee" + integrity sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw== + +brace-expansion@^2.0.1: + version "2.0.1" + resolved "https://registry.yarnpkg.com/brace-expansion/-/brace-expansion-2.0.1.tgz#1edc459e0f0c548486ecf9fc99f2221364b9a0ae" + integrity sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA== + dependencies: + balanced-match "^1.0.0" + +commander@~9.4.1: + version "9.4.1" + resolved "https://registry.yarnpkg.com/commander/-/commander-9.4.1.tgz#d1dd8f2ce6faf93147295c0df13c7c21141cfbdd" + integrity sha512-5EEkTNyHNGFPD2H+c/dXXfQZYa/scCKasxWcXJaWnNJ99pnQN9Vnmqow+p+PlFPE63Q6mThaZws1T+HxfpgtPw== + +deep-extend@^0.6.0: + version "0.6.0" + resolved "https://registry.yarnpkg.com/deep-extend/-/deep-extend-0.6.0.tgz#c4fa7c95404a17a9c3e8ca7e1537312b736330ac" + integrity sha512-LOHxIOaPYdHlJRtCQfDIVZtfw/ufM8+rVj649RIHzcm/vGwQRXFt6OPqIFWsm2XEMrNIEtWR64sY1LEKD2vAOA== + +entities@~3.0.1: + version "3.0.1" + resolved "https://registry.yarnpkg.com/entities/-/entities-3.0.1.tgz#2b887ca62585e96db3903482d336c1006c3001d4" + integrity sha512-WiyBqoomrwMdFG1e0kqvASYfnlb0lp8M5o5Fw2OFq1hNZxxcNk8Ik0Xm7LxzBhuidnZB/UtBqVCgUz3kBOP51Q== + +fs.realpath@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/fs.realpath/-/fs.realpath-1.0.0.tgz#1504ad2523158caa40db4a2787cb01411994ea4f" + integrity sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw== + +get-stdin@~9.0.0: + version "9.0.0" + resolved "https://registry.yarnpkg.com/get-stdin/-/get-stdin-9.0.0.tgz#3983ff82e03d56f1b2ea0d3e60325f39d703a575" + integrity sha512-dVKBjfWisLAicarI2Sf+JuBE/DghV4UzNAVe9yhEJuzeREd3JhOTE9cUaJTeSa77fsbQUK3pcOpJfM59+VKZaA== + +glob@~8.0.3: + version "8.0.3" + resolved "https://registry.yarnpkg.com/glob/-/glob-8.0.3.tgz#415c6eb2deed9e502c68fa44a272e6da6eeca42e" + integrity sha512-ull455NHSHI/Y1FqGaaYFaLGkNMMJbavMrEGFXG/PGrg6y7sutWHUHrz6gy6WEBH6akM1M414dWKCNs+IhKdiQ== + dependencies: + fs.realpath "^1.0.0" + inflight "^1.0.4" + inherits "2" + minimatch "^5.0.1" + once "^1.3.0" + +ignore@~5.2.4: + version "5.2.4" + resolved "https://registry.yarnpkg.com/ignore/-/ignore-5.2.4.tgz#a291c0c6178ff1b960befe47fcdec301674a6324" + integrity sha512-MAb38BcSbH0eHNBxn7ql2NH/kX33OkB3lZ1BNdh7ENeRChHTYsTvWrMubiIAMNS2llXEEgZ1MUOBtXChP3kaFQ== + +inflight@^1.0.4: + version "1.0.6" + resolved "https://registry.yarnpkg.com/inflight/-/inflight-1.0.6.tgz#49bd6331d7d02d0c09bc910a1075ba8165b56df9" + integrity sha512-k92I/b08q4wvFscXCLvqfsHCrjrF7yiXsQuIVvVE7N82W3+aqpzuUdBbfhWcy/FZR3/4IgflMgKLOsvPDrGCJA== + dependencies: + once "^1.3.0" + wrappy "1" + +inherits@2: + version "2.0.4" + resolved "https://registry.yarnpkg.com/inherits/-/inherits-2.0.4.tgz#0fa2c64f932917c3433a0ded55363aae37416b7c" + integrity sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ== + +ini@~3.0.0: + version "3.0.1" + resolved "https://registry.yarnpkg.com/ini/-/ini-3.0.1.tgz#c76ec81007875bc44d544ff7a11a55d12294102d" + integrity sha512-it4HyVAUTKBc6m8e1iXWvXSTdndF7HbdN713+kvLrymxTaU4AUBWrJ4vEooP+V7fexnVD3LKcBshjGGPefSMUQ== + +js-yaml@^4.1.0: + version "4.1.0" + resolved "https://registry.yarnpkg.com/js-yaml/-/js-yaml-4.1.0.tgz#c1fb65f8f5017901cdd2c951864ba18458a10602" + integrity sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA== + dependencies: + argparse "^2.0.1" + +jsonc-parser@~3.2.0: + version "3.2.1" + resolved "https://registry.yarnpkg.com/jsonc-parser/-/jsonc-parser-3.2.1.tgz#031904571ccf929d7670ee8c547545081cb37f1a" + integrity sha512-AilxAyFOAcK5wA1+LeaySVBrHsGQvUFCDWXKpZjzaL0PqW+xfBOttn8GNtWKFWqneyMZj41MWF9Kl6iPWLwgOA== + +linkify-it@^4.0.1: + version "4.0.1" + resolved "https://registry.yarnpkg.com/linkify-it/-/linkify-it-4.0.1.tgz#01f1d5e508190d06669982ba31a7d9f56a5751ec" + integrity sha512-C7bfi1UZmoj8+PQx22XyeXCuBlokoyWQL5pWSP+EI6nzRylyThouddufc2c1NDIcP9k5agmN9fLpA7VNJfIiqw== + dependencies: + uc.micro "^1.0.1" + +markdown-it@13.0.1: + version "13.0.1" + resolved "https://registry.yarnpkg.com/markdown-it/-/markdown-it-13.0.1.tgz#c6ecc431cacf1a5da531423fc6a42807814af430" + integrity sha512-lTlxriVoy2criHP0JKRhO2VDG9c2ypWCsT237eDiLqi09rmbKoUetyGHq2uOIRoRS//kfoJckS0eUzzkDR+k2Q== + dependencies: + argparse "^2.0.1" + entities "~3.0.1" + linkify-it "^4.0.1" + mdurl "^1.0.1" + uc.micro "^1.0.5" + +markdownlint-cli@^0.33.0: + version "0.33.0" + resolved "https://registry.yarnpkg.com/markdownlint-cli/-/markdownlint-cli-0.33.0.tgz#703af1234c32c309ab52fcd0e8bc797a34e2b096" + integrity sha512-zMK1oHpjYkhjO+94+ngARiBBrRDEUMzooDHBAHtmEIJ9oYddd9l3chCReY2mPlecwH7gflQp1ApilTo+o0zopQ== + dependencies: + commander "~9.4.1" + get-stdin "~9.0.0" + glob "~8.0.3" + ignore "~5.2.4" + js-yaml "^4.1.0" + jsonc-parser "~3.2.0" + markdownlint "~0.27.0" + minimatch "~5.1.2" + run-con "~1.2.11" + +markdownlint@^0.27.0, markdownlint@~0.27.0: + version "0.27.0" + resolved "https://registry.yarnpkg.com/markdownlint/-/markdownlint-0.27.0.tgz#9dabf7710a4999e2835e3c68317f1acd0bc89049" + integrity sha512-HtfVr/hzJJmE0C198F99JLaeada+646B5SaG2pVoEakLFI6iRGsvMqrnnrflq8hm1zQgwskEgqSnhDW11JBp0w== + dependencies: + markdown-it "13.0.1" + +mdurl@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/mdurl/-/mdurl-1.0.1.tgz#fe85b2ec75a59037f2adfec100fd6c601761152e" + integrity sha512-/sKlQJCBYVY9Ers9hqzKou4H6V5UWc/M59TH2dvkt+84itfnq7uFOMLpOiOS4ujvHP4etln18fmIxA5R5fll0g== + +minimatch@^5.0.1, minimatch@~5.1.2: + version "5.1.6" + resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-5.1.6.tgz#1cfcb8cf5522ea69952cd2af95ae09477f122a96" + integrity sha512-lKwV/1brpG6mBUFHtb7NUmtABCb2WZZmm2wNiOA5hAb8VdCS4B3dtMWyvcoViccwAW/COERjXLt0zP1zXUN26g== + dependencies: + brace-expansion "^2.0.1" + +minimist@^1.2.8: + version "1.2.8" + resolved "https://registry.yarnpkg.com/minimist/-/minimist-1.2.8.tgz#c1a464e7693302e082a075cee0c057741ac4772c" + integrity sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA== + +once@^1.3.0: + version "1.4.0" + resolved "https://registry.yarnpkg.com/once/-/once-1.4.0.tgz#583b1aa775961d4b113ac17d9c50baef9dd76bd1" + integrity sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w== + dependencies: + wrappy "1" + +prettier@^2.8.3: + version "2.8.8" + resolved "https://registry.yarnpkg.com/prettier/-/prettier-2.8.8.tgz#e8c5d7e98a4305ffe3de2e1fc4aca1a71c28b1da" + integrity sha512-tdN8qQGvNjw4CHbY+XXk0JgCXn9QiF21a55rBe5LJAU+kDyC4WQn4+awm2Xfk2lQMk5fKup9XgzTZtGkjBdP9Q== + +run-con@~1.2.11: + version "1.2.12" + resolved "https://registry.yarnpkg.com/run-con/-/run-con-1.2.12.tgz#51c319910e45a3bd71ee773564a89d96635c8c64" + integrity sha512-5257ILMYIF4RztL9uoZ7V9Q97zHtNHn5bN3NobeAnzB1P3ASLgg8qocM2u+R18ttp+VEM78N2LK8XcNVtnSRrg== + dependencies: + deep-extend "^0.6.0" + ini "~3.0.0" + minimist "^1.2.8" + strip-json-comments "~3.1.1" + +strip-json-comments@~3.1.1: + version "3.1.1" + resolved "https://registry.yarnpkg.com/strip-json-comments/-/strip-json-comments-3.1.1.tgz#31f1281b3832630434831c310c01cccda8cbe006" + integrity sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig== + +uc.micro@^1.0.1, uc.micro@^1.0.5: + version "1.0.6" + resolved "https://registry.yarnpkg.com/uc.micro/-/uc.micro-1.0.6.tgz#9c411a802a409a91fc6cf74081baba34b24499ac" + integrity sha512-8Y75pvTYkLJW2hWQHXxoqRgV7qb9B+9vFEtidML+7koHUFapnVJAZ6cKs+Qjz5Aw3aZWHMC6u0wJE3At+nSGwA== + +wrappy@1: + version "1.0.2" + resolved "https://registry.yarnpkg.com/wrappy/-/wrappy-1.0.2.tgz#b5243d8f3ec1aa35f1364605bc0d1036e30ab69f" + integrity sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ== From f76d7ada9e534fc2ad363494c6b72c9b3b794d9a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rafa=C5=82=20Schmidt?= Date: Tue, 27 Feb 2024 22:19:11 +0100 Subject: [PATCH 2/3] refactor: remove NetCoreVersions --- src/Allegro.DotnetSdk/Sdk/Sdk.props | 6 ------ 1 file changed, 6 deletions(-) diff --git a/src/Allegro.DotnetSdk/Sdk/Sdk.props b/src/Allegro.DotnetSdk/Sdk/Sdk.props index dd6385d..2d67946 100644 --- a/src/Allegro.DotnetSdk/Sdk/Sdk.props +++ b/src/Allegro.DotnetSdk/Sdk/Sdk.props @@ -10,12 +10,6 @@ Import our custom targets after Directory.Build.targets is imported --> $(CustomAfterDirectoryBuildTargets);$(MSBuildThisFileDirectory)Allegro.NET.Sdk.targets - - - net6.0 From bb4e8ef6b62799a16bcf5a7368c203e493fa3cb6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rafa=C5=82=20Schmidt?= Date: Wed, 28 Feb 2024 10:57:16 +0100 Subject: [PATCH 3/3] docs: change analyzers section and remove formatter --- .gitignore | 3 +- README.md | 148 ++++---------- package.json | 13 -- .../projects/Net6SdkError/README.md | 3 +- .../projects/Net8LibWarning/README.md | 3 +- yarn.lock | 185 ------------------ 6 files changed, 41 insertions(+), 314 deletions(-) delete mode 100644 package.json delete mode 100644 yarn.lock diff --git a/.gitignore b/.gitignore index f287f3d..ea39a34 100644 --- a/.gitignore +++ b/.gitignore @@ -23,5 +23,4 @@ BenchmarkDotNet.Artifacts paket-files/ .DS_Store .vscode/ -coverage.* -node_modules/ \ No newline at end of file +coverage.* \ No newline at end of file diff --git a/README.md b/README.md index 7382603..9058a50 100644 --- a/README.md +++ b/README.md @@ -2,29 +2,23 @@ ## About -The Allegro .NET SDK provides common and importable project settings, such as -build properties, coding styles, analyzers configuration etc. +The Allegro .NET SDK provides common and importable project settings, such as build properties, coding styles, analyzers configuration etc. -The SDK is versioned and published on nuget. It can be imported into dotnet -projects. +The SDK is versioned and published on nuget. It can be imported into dotnet projects. ## Using the SDK -The SDK is meant to be easily importable - only a few initial config lines are -required to bring its benefits. The SDK also makes it possible to override any -of its default settings. Version 2+ will work only with .NET SDK v8+. +The SDK is meant to be easily importable - only a few initial config lines are required to bring its benefits. The SDK also makes it possible to override any of its default settings. Version 2+ will work only with .NET SDK v8+. ## Importing The sections below list the changes required in order to import the SDK. -Additional information can be found in the docs - -[Reference a project SDK](https://docs.microsoft.com/en-us/visualstudio/msbuild/how-to-use-project-sdk?view=vs-2022#reference-a-project-sdk). +Additional information can be found in the docs - [Reference a project SDK](https://docs.microsoft.com/en-us/visualstudio/msbuild/how-to-use-project-sdk?view=vs-2022#reference-a-project-sdk). ### global.json -It's necessary to include `Allegro.DotnetSdk` with the desired version in -`global.json` in the repository root: +It's necessary to include `Allegro.DotnetSdk` with the desired version in `global.json` in the repository root: ```json { @@ -36,18 +30,17 @@ It's necessary to include `Allegro.DotnetSdk` with the desired version in "Allegro.DotnetSdk": "2.1.0" } } + ``` ### Directory.Build.props -The `Directory.Build.props` file should be updated in order to actually import -the SDK: +The `Directory.Build.props` file should be updated in order to actually import the SDK: ```xml - - - + + ``` @@ -56,37 +49,25 @@ the SDK: Most properties are only set in the SDK if not configured by the project. -To configure the SDK, the following properties can be added into -`Directory.Build.props` or `.*proj` files: - -- `AllegroDotnetSdkEnableXmlDocAdjustments` (default: true) - enable doc file - generation, suppress missing-comments warning (1591) - completely in test - projects, as errors otherwise (keep as warning). -- `AllegroDotnetSdkTreatWarningsAsErrors` (default: true in CI and Rider IDE) - - to enable in local shell or other IDEs, just set your own user environment - variable `TreatWarningsAsErrors=true`. -- `AllegroDotnetSdkEnableGlobalEditorConfig` (default: true) - add - `editorconfig.global` analyzer configuration file. -- `AllegroDotnetSdkEnablePackAdjustments` (default: true) - sets - PublishRepositoryUrl and enables `.snupkg` symbols. -- `AllegroDotnetSdkEnableAzureArtifactsAdjustments` (default: false) - disables - `.snupkg` and instead embeds PDBs in `.nupkg`. +To configure the SDK, the following properties can be added into `Directory.Build.props` or `.*proj` files: + +- `AllegroDotnetSdkEnableXmlDocAdjustments` (default: true) - enable doc file generation, suppress missing-comments warning (1591) - completely in test projects, as errors otherwise (keep as warning). +- `AllegroDotnetSdkTreatWarningsAsErrors` (default: true in CI and Rider IDE) - to enable in local shell or other IDEs, just set your own user environment variable `TreatWarningsAsErrors=true`. +- `AllegroDotnetSdkEnableGlobalEditorConfig` (default: true) - add `editorconfig.global` analyzer configuration file. +- `AllegroDotnetSdkEnablePackAdjustments` (default: true) - sets PublishRepositoryUrl and enables `.snupkg` symbols. +- `AllegroDotnetSdkEnableAzureArtifactsAdjustments` (default: false) - disables `.snupkg` and instead embeds PDBs in `.nupkg`. For `C#` only: -- `AllegroDotnetSdkEnableImplicitUsingsAdjustments` (default: true for C#) - add - `System.Collections.Immutable` and remove `Microsoft.Extensions.Logging` and - `System.Net.Http` implicit usings. -- `AllegroDotnetSdkEnableStyleCopConfig` (default: true for C#) - references a - preset `stylecop.json`. +- `AllegroDotnetSdkEnableImplicitUsingsAdjustments` (default: true for C#) - add `System.Collections.Immutable` and remove `Microsoft.Extensions.Logging` and `System.Net.Http` implicit usings. +- `AllegroDotnetSdkEnableStyleCopConfig` (default: true for C#) - references a preset `stylecop.json`. Configure in `Directory.Build.props` - repo wide: ```xml - - + @@ -101,7 +82,6 @@ Configure in `Directory.Build.props` - repo wide: Configure in `*.csproj` - project settings: ```xml - @@ -114,104 +94,52 @@ Configure in `*.csproj` - project settings: ## Analyzers -This SDK exclusively specifies rules for analyzers. Avoiding direct references -ensures that developers can seamlessly apply and update analyzers without being -tied to specific versions. - -To add analyzers via CPM: +This SDK provides some default configuration (rules severity) for selected analyzers: StyleCop, Meziantou and AsyncFixer. It doesn't actually reference them. Avoiding direct references ensures that developers can seamlessly apply and update analyzers without being tied to specific versions. +To add analyzers, include the following in your `Directory.Build.props` or `Directory.Packages.props` file: + ```xml - - ... - - - - true - true - - + - ... - -``` - -and without central package management: - -```xml - - - ... - - - - all - runtime; build; native; contentfiles; analyzers - - - - all - runtime; build; native; contentfiles; analyzers - - - - all - runtime; build; native; contentfiles; analyzers - - - ... + ``` ## Editor config -The SDK contains a global analyzer config file containing the default -configuration for various analyzers and formatters. +The SDK contains a global analyzer config file containing the default configuration for various analyzers and formatters. -Its entries can be also overridden by entries from `.editorconfig`. Such editor -config files are merged with the imported global config file. +Its entries can be also overridden by entries from `.editorconfig`. Such editor config files are merged with the imported global config file. -More about the analyzer and editor config files can be found in -[the docs](https://docs.microsoft.com/en-us/dotnet/fundamentals/code-analysis/configuration-files). +More about the analyzer and editor config files can be found in [the docs](https://docs.microsoft.com/en-us/dotnet/fundamentals/code-analysis/configuration-files). ## IDEs support -### Rider +### Rider Make sure you have enabled: - Preferences -> Editor -> Code Style -> Enable StyleCop support (Ruleset files) - Preferences -> Editor -> Code Style -> Enable EditorConfig support -- Preferences -> Editor -> Inspection Settings -> Read settings from - editorconfig, project settings and rule sets -- Preferences -> Editor -> Inspection Settings -> Roslyn -> Enable Roslyn - analyzers and Source Generators -- Preferences -> Editor -> Inspection Settings -> Roslyn -> Include Roslyn - analyzers in Solution-Wide Analysis - -**Be aware!** Only some analyzers's warnings can be addressed by auto-format or -code cleanup. Some of the warnings are not covered by Rider, and its settings -need to be adjusted. -For that, in editor.globalconfig is `# ReSharper properties` section with some -already defined settings which align with analyzers. If you find some -inconsistency and you find appropriate settings in Rider, which will fix it - -please, contribute! :) +- Preferences -> Editor -> Inspection Settings -> Read settings from editorconfig, project settings and rule sets +- Preferences -> Editor -> Inspection Settings -> Roslyn -> Enable Roslyn analyzers and Source Generators +- Preferences -> Editor -> Inspection Settings -> Roslyn -> Include Roslyn analyzers in Solution-Wide Analysis + +**Be aware!** +Only some analyzers's warnings can be addressed by auto-format or code cleanup. Some of the warnings are not covered by Rider, and its settings need to be adjusted. +For that, in editor.globalconfig is `# ReSharper properties` section with some already defined settings which align with analyzers. If you find some inconsistency and you find appropriate settings in Rider, which will fix it - please, contribute! :) ## License Copyright Allegro Group -Licensed under the Apache License, Version 2.0 (the "License"); you may not use -this file except in compliance with the License. You may obtain a copy of the -License at +Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at -`http://www.apache.org/licenses/LICENSE-2.0` +```http://www.apache.org/licenses/LICENSE-2.0``` -Unless required by applicable law or agreed to in writing, software distributed -under the License is distributed on an " AS IS" BASIS, WITHOUT WARRANTIES OR -CONDITIONS OF ANY KIND, either express or implied. See the License for the -specific language governing permissions and limitations under the License. +Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. diff --git a/package.json b/package.json deleted file mode 100644 index f4bdcb2..0000000 --- a/package.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "name": "SDK", - "devDependencies": { - "markdownlint": "^0.27.0", - "markdownlint-cli": "^0.33.0", - "prettier": "^2.8.3" - }, - "scripts": { - "format:markdown": "prettier --write \"**/**/*.md\" --prose-wrap always --parser markdown", - "format:check:markdown": "prettier --check \"**/**/*.md\" --prose-wrap always --parser markdown", - "format:lint:markdown": "markdownlint --fix --ignore node_modules --fix \"**/**/*.md\"" - } -} diff --git a/src/Allegro.DotnetSdk.Tests/projects/Net6SdkError/README.md b/src/Allegro.DotnetSdk.Tests/projects/Net6SdkError/README.md index 52cf5f7..abc7bf2 100644 --- a/src/Allegro.DotnetSdk.Tests/projects/Net6SdkError/README.md +++ b/src/Allegro.DotnetSdk.Tests/projects/Net6SdkError/README.md @@ -1,4 +1,3 @@ This project should fail with an error message: -> error : Allegro.DotnetSdk requires .NET SDK v8.0.100+ to be used, but 6.0.x -> was found. +> error : Allegro.DotnetSdk requires .NET SDK v8.0.100+ to be used, but 6.0.x was found. diff --git a/src/Allegro.DotnetSdk.Tests/projects/Net8LibWarning/README.md b/src/Allegro.DotnetSdk.Tests/projects/Net8LibWarning/README.md index e6e0ab8..02a22ea 100644 --- a/src/Allegro.DotnetSdk.Tests/projects/Net8LibWarning/README.md +++ b/src/Allegro.DotnetSdk.Tests/projects/Net8LibWarning/README.md @@ -1,4 +1,3 @@ This project should fail with an error message: -> warning CS1591: Missing XML comment for publicly visible type or member -> 'Class1' +> warning CS1591: Missing XML comment for publicly visible type or member 'Class1' diff --git a/yarn.lock b/yarn.lock deleted file mode 100644 index 721cf54..0000000 --- a/yarn.lock +++ /dev/null @@ -1,185 +0,0 @@ -# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. -# yarn lockfile v1 - - -argparse@^2.0.1: - version "2.0.1" - resolved "https://registry.yarnpkg.com/argparse/-/argparse-2.0.1.tgz#246f50f3ca78a3240f6c997e8a9bd1eac49e4b38" - integrity sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q== - -balanced-match@^1.0.0: - version "1.0.2" - resolved "https://registry.yarnpkg.com/balanced-match/-/balanced-match-1.0.2.tgz#e83e3a7e3f300b34cb9d87f615fa0cbf357690ee" - integrity sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw== - -brace-expansion@^2.0.1: - version "2.0.1" - resolved "https://registry.yarnpkg.com/brace-expansion/-/brace-expansion-2.0.1.tgz#1edc459e0f0c548486ecf9fc99f2221364b9a0ae" - integrity sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA== - dependencies: - balanced-match "^1.0.0" - -commander@~9.4.1: - version "9.4.1" - resolved "https://registry.yarnpkg.com/commander/-/commander-9.4.1.tgz#d1dd8f2ce6faf93147295c0df13c7c21141cfbdd" - integrity sha512-5EEkTNyHNGFPD2H+c/dXXfQZYa/scCKasxWcXJaWnNJ99pnQN9Vnmqow+p+PlFPE63Q6mThaZws1T+HxfpgtPw== - -deep-extend@^0.6.0: - version "0.6.0" - resolved "https://registry.yarnpkg.com/deep-extend/-/deep-extend-0.6.0.tgz#c4fa7c95404a17a9c3e8ca7e1537312b736330ac" - integrity sha512-LOHxIOaPYdHlJRtCQfDIVZtfw/ufM8+rVj649RIHzcm/vGwQRXFt6OPqIFWsm2XEMrNIEtWR64sY1LEKD2vAOA== - -entities@~3.0.1: - version "3.0.1" - resolved "https://registry.yarnpkg.com/entities/-/entities-3.0.1.tgz#2b887ca62585e96db3903482d336c1006c3001d4" - integrity sha512-WiyBqoomrwMdFG1e0kqvASYfnlb0lp8M5o5Fw2OFq1hNZxxcNk8Ik0Xm7LxzBhuidnZB/UtBqVCgUz3kBOP51Q== - -fs.realpath@^1.0.0: - version "1.0.0" - resolved "https://registry.yarnpkg.com/fs.realpath/-/fs.realpath-1.0.0.tgz#1504ad2523158caa40db4a2787cb01411994ea4f" - integrity sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw== - -get-stdin@~9.0.0: - version "9.0.0" - resolved "https://registry.yarnpkg.com/get-stdin/-/get-stdin-9.0.0.tgz#3983ff82e03d56f1b2ea0d3e60325f39d703a575" - integrity sha512-dVKBjfWisLAicarI2Sf+JuBE/DghV4UzNAVe9yhEJuzeREd3JhOTE9cUaJTeSa77fsbQUK3pcOpJfM59+VKZaA== - -glob@~8.0.3: - version "8.0.3" - resolved "https://registry.yarnpkg.com/glob/-/glob-8.0.3.tgz#415c6eb2deed9e502c68fa44a272e6da6eeca42e" - integrity sha512-ull455NHSHI/Y1FqGaaYFaLGkNMMJbavMrEGFXG/PGrg6y7sutWHUHrz6gy6WEBH6akM1M414dWKCNs+IhKdiQ== - dependencies: - fs.realpath "^1.0.0" - inflight "^1.0.4" - inherits "2" - minimatch "^5.0.1" - once "^1.3.0" - -ignore@~5.2.4: - version "5.2.4" - resolved "https://registry.yarnpkg.com/ignore/-/ignore-5.2.4.tgz#a291c0c6178ff1b960befe47fcdec301674a6324" - integrity sha512-MAb38BcSbH0eHNBxn7ql2NH/kX33OkB3lZ1BNdh7ENeRChHTYsTvWrMubiIAMNS2llXEEgZ1MUOBtXChP3kaFQ== - -inflight@^1.0.4: - version "1.0.6" - resolved "https://registry.yarnpkg.com/inflight/-/inflight-1.0.6.tgz#49bd6331d7d02d0c09bc910a1075ba8165b56df9" - integrity sha512-k92I/b08q4wvFscXCLvqfsHCrjrF7yiXsQuIVvVE7N82W3+aqpzuUdBbfhWcy/FZR3/4IgflMgKLOsvPDrGCJA== - dependencies: - once "^1.3.0" - wrappy "1" - -inherits@2: - version "2.0.4" - resolved "https://registry.yarnpkg.com/inherits/-/inherits-2.0.4.tgz#0fa2c64f932917c3433a0ded55363aae37416b7c" - integrity sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ== - -ini@~3.0.0: - version "3.0.1" - resolved "https://registry.yarnpkg.com/ini/-/ini-3.0.1.tgz#c76ec81007875bc44d544ff7a11a55d12294102d" - integrity sha512-it4HyVAUTKBc6m8e1iXWvXSTdndF7HbdN713+kvLrymxTaU4AUBWrJ4vEooP+V7fexnVD3LKcBshjGGPefSMUQ== - -js-yaml@^4.1.0: - version "4.1.0" - resolved "https://registry.yarnpkg.com/js-yaml/-/js-yaml-4.1.0.tgz#c1fb65f8f5017901cdd2c951864ba18458a10602" - integrity sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA== - dependencies: - argparse "^2.0.1" - -jsonc-parser@~3.2.0: - version "3.2.1" - resolved "https://registry.yarnpkg.com/jsonc-parser/-/jsonc-parser-3.2.1.tgz#031904571ccf929d7670ee8c547545081cb37f1a" - integrity sha512-AilxAyFOAcK5wA1+LeaySVBrHsGQvUFCDWXKpZjzaL0PqW+xfBOttn8GNtWKFWqneyMZj41MWF9Kl6iPWLwgOA== - -linkify-it@^4.0.1: - version "4.0.1" - resolved "https://registry.yarnpkg.com/linkify-it/-/linkify-it-4.0.1.tgz#01f1d5e508190d06669982ba31a7d9f56a5751ec" - integrity sha512-C7bfi1UZmoj8+PQx22XyeXCuBlokoyWQL5pWSP+EI6nzRylyThouddufc2c1NDIcP9k5agmN9fLpA7VNJfIiqw== - dependencies: - uc.micro "^1.0.1" - -markdown-it@13.0.1: - version "13.0.1" - resolved "https://registry.yarnpkg.com/markdown-it/-/markdown-it-13.0.1.tgz#c6ecc431cacf1a5da531423fc6a42807814af430" - integrity sha512-lTlxriVoy2criHP0JKRhO2VDG9c2ypWCsT237eDiLqi09rmbKoUetyGHq2uOIRoRS//kfoJckS0eUzzkDR+k2Q== - dependencies: - argparse "^2.0.1" - entities "~3.0.1" - linkify-it "^4.0.1" - mdurl "^1.0.1" - uc.micro "^1.0.5" - -markdownlint-cli@^0.33.0: - version "0.33.0" - resolved "https://registry.yarnpkg.com/markdownlint-cli/-/markdownlint-cli-0.33.0.tgz#703af1234c32c309ab52fcd0e8bc797a34e2b096" - integrity sha512-zMK1oHpjYkhjO+94+ngARiBBrRDEUMzooDHBAHtmEIJ9oYddd9l3chCReY2mPlecwH7gflQp1ApilTo+o0zopQ== - dependencies: - commander "~9.4.1" - get-stdin "~9.0.0" - glob "~8.0.3" - ignore "~5.2.4" - js-yaml "^4.1.0" - jsonc-parser "~3.2.0" - markdownlint "~0.27.0" - minimatch "~5.1.2" - run-con "~1.2.11" - -markdownlint@^0.27.0, markdownlint@~0.27.0: - version "0.27.0" - resolved "https://registry.yarnpkg.com/markdownlint/-/markdownlint-0.27.0.tgz#9dabf7710a4999e2835e3c68317f1acd0bc89049" - integrity sha512-HtfVr/hzJJmE0C198F99JLaeada+646B5SaG2pVoEakLFI6iRGsvMqrnnrflq8hm1zQgwskEgqSnhDW11JBp0w== - dependencies: - markdown-it "13.0.1" - -mdurl@^1.0.1: - version "1.0.1" - resolved "https://registry.yarnpkg.com/mdurl/-/mdurl-1.0.1.tgz#fe85b2ec75a59037f2adfec100fd6c601761152e" - integrity sha512-/sKlQJCBYVY9Ers9hqzKou4H6V5UWc/M59TH2dvkt+84itfnq7uFOMLpOiOS4ujvHP4etln18fmIxA5R5fll0g== - -minimatch@^5.0.1, minimatch@~5.1.2: - version "5.1.6" - resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-5.1.6.tgz#1cfcb8cf5522ea69952cd2af95ae09477f122a96" - integrity sha512-lKwV/1brpG6mBUFHtb7NUmtABCb2WZZmm2wNiOA5hAb8VdCS4B3dtMWyvcoViccwAW/COERjXLt0zP1zXUN26g== - dependencies: - brace-expansion "^2.0.1" - -minimist@^1.2.8: - version "1.2.8" - resolved "https://registry.yarnpkg.com/minimist/-/minimist-1.2.8.tgz#c1a464e7693302e082a075cee0c057741ac4772c" - integrity sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA== - -once@^1.3.0: - version "1.4.0" - resolved "https://registry.yarnpkg.com/once/-/once-1.4.0.tgz#583b1aa775961d4b113ac17d9c50baef9dd76bd1" - integrity sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w== - dependencies: - wrappy "1" - -prettier@^2.8.3: - version "2.8.8" - resolved "https://registry.yarnpkg.com/prettier/-/prettier-2.8.8.tgz#e8c5d7e98a4305ffe3de2e1fc4aca1a71c28b1da" - integrity sha512-tdN8qQGvNjw4CHbY+XXk0JgCXn9QiF21a55rBe5LJAU+kDyC4WQn4+awm2Xfk2lQMk5fKup9XgzTZtGkjBdP9Q== - -run-con@~1.2.11: - version "1.2.12" - resolved "https://registry.yarnpkg.com/run-con/-/run-con-1.2.12.tgz#51c319910e45a3bd71ee773564a89d96635c8c64" - integrity sha512-5257ILMYIF4RztL9uoZ7V9Q97zHtNHn5bN3NobeAnzB1P3ASLgg8qocM2u+R18ttp+VEM78N2LK8XcNVtnSRrg== - dependencies: - deep-extend "^0.6.0" - ini "~3.0.0" - minimist "^1.2.8" - strip-json-comments "~3.1.1" - -strip-json-comments@~3.1.1: - version "3.1.1" - resolved "https://registry.yarnpkg.com/strip-json-comments/-/strip-json-comments-3.1.1.tgz#31f1281b3832630434831c310c01cccda8cbe006" - integrity sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig== - -uc.micro@^1.0.1, uc.micro@^1.0.5: - version "1.0.6" - resolved "https://registry.yarnpkg.com/uc.micro/-/uc.micro-1.0.6.tgz#9c411a802a409a91fc6cf74081baba34b24499ac" - integrity sha512-8Y75pvTYkLJW2hWQHXxoqRgV7qb9B+9vFEtidML+7koHUFapnVJAZ6cKs+Qjz5Aw3aZWHMC6u0wJE3At+nSGwA== - -wrappy@1: - version "1.0.2" - resolved "https://registry.yarnpkg.com/wrappy/-/wrappy-1.0.2.tgz#b5243d8f3ec1aa35f1364605bc0d1036e30ab69f" - integrity sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==