Additional settings file for developement

Ouverte
#2,184 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
5/5
Temps estimé
Plus d'une semaine
Accessibilité débutants
35/100
Type d'issue
Fonctionnalité
Clarté
Plutôt claire
Activité
Calme
Stack technique
powershell, vscode

Piste de recherche

Commencez par le fichier fourni PSScriptAnalyzerSettings.psd1 et le paramètre VSCode powershell.scriptAnalysis.settingsPath mentionné dans l’issue. Comparez les exigences de la conception et de la CI, puis déterminez les règles axées sur le développement et la manière dont le fichier supplémentaire doit être livré. C’est terminé lorsqu’un fichier de configuration de développement séparé est disponible sans modifier le fichier de configuration existant.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

Summary of the new feature

There is currently one PSScriptAnalyzerSettings.psd1 file shipped with the PSScriptAnalyzer but there are at least two use cases with a different requirement:

  • Design-time
    During this phase (often done is VSCode or Visual Studio), any cutting-edge alert for a potential PowerShell pitfall is welcome.

  • Continuous Integration
    During this phase (e.g. in a CI/CD street), any change is supposed to passed the given tests.

Apparently, there is a (undocumented?) convention that our convention is to ship it opt-in via ConfigurableRule with Enable = false but that convention only satisfies the builder phase.

Proposed technical implementation details (optional)

Ship the PSScriptAnalyzer with an additional settings file that is focused on the development phase.
The "development" settings file might than be used as a default by e.g. VSCode (powershell.scriptAnalysis.settingsPath).

Caveats

What is the latest version of PSScriptAnalyzer at the point of writing

1.25.0

Langage dominant
C#
Étoiles
2.2k
Forks
415
Merge moyen
13 h 1 min
PR mergées (30 j)
2

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de PowerShell/PSScriptAnalyzer

Toutes les issues de PowerShell/PSScriptAnalyzer

Issues similaires

Plus d'issues C#

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.