Merge pull request #3 from swinton/use-local-eslint-formatter

Use local eslint formatter

Author: Steve Winton

.github/workflows/upload-sarif.yml

@@ -17,7 +17,7 @@ jobs:
     # Runs the ESlint code analysis
     - name: Run ESLint
       # eslint exits 1 if it finds anything to report
-      run: node_modules/.bin/eslint index.js -f node_modules/@microsoft/eslint-formatter-sarif/sarif.js -o results.sarif.json || true
+      run: npm run lint || true
     - name: Expose report
       uses: actions/upload-artifact@v2
       with:

eslint-formatter/.gitattributes

@@ -0,0 +1,63 @@
+###############################################################################
+# Set default behavior to automatically normalize line endings.
+###############################################################################
+* text=auto
+
+###############################################################################
+# Set default behavior for command prompt diff.
+#
+# This is need for earlier builds of msysgit that does not have it on by
+# default for csharp files.
+# Note: This is only used by command line
+###############################################################################
+#*.cs     diff=csharp
+
+###############################################################################
+# Set the merge driver for project and solution files
+#
+# Merging from the command prompt will add diff markers to the files if there
+# are conflicts (Merging from VS is not affected by the settings below, in VS
+# the diff markers are never inserted). Diff markers may cause the following 
+# file extensions to fail to load in VS. An alternative would be to treat
+# these files as binary and thus will always conflict and require user
+# intervention with every merge. To do so, just uncomment the entries below
+###############################################################################
+#*.sln       merge=binary
+#*.csproj    merge=binary
+#*.vbproj    merge=binary
+#*.vcxproj   merge=binary
+#*.vcproj    merge=binary
+#*.dbproj    merge=binary
+#*.fsproj    merge=binary
+#*.lsproj    merge=binary
+#*.wixproj   merge=binary
+#*.modelproj merge=binary
+#*.sqlproj   merge=binary
+#*.wwaproj   merge=binary
+
+###############################################################################
+# behavior for image files
+#
+# image files are treated as binary by default.
+###############################################################################
+#*.jpg   binary
+#*.png   binary
+#*.gif   binary
+
+###############################################################################
+# diff behavior for common document formats
+# 
+# Convert binary document formats to text before diffing them. This feature
+# is only available from the command line. Turn it on by uncommenting the 
+# entries below.
+###############################################################################
+#*.doc   diff=astextplain
+#*.DOC   diff=astextplain
+#*.docx  diff=astextplain
+#*.DOCX  diff=astextplain
+#*.dot   diff=astextplain
+#*.DOT   diff=astextplain
+#*.pdf   diff=astextplain
+#*.PDF   diff=astextplain
+#*.rtf   diff=astextplain
+#*.RTF   diff=astextplain

eslint-formatter/.github/ISSUE_TEMPLATE/validation-rule-request.md

@@ -0,0 +1,47 @@
+---
+name        : Validation rule request
+about       : A detailed specification for a new SARIF validation rule to add to the Sarif.Multitool validate command.
+title       : "[RULE REQUEST] Concise description of new analysis"
+labels      : validation-rule-request
+assignees   : ''
+
+---
+
+---
+
+# Rule Proposal: [Friendly Rule Name]
+- *Synopsis*                : [Brief summary of the rule, include code snippets if possible.]
+
+- *[Violation Example]*     : [Optional, Include code snippet which should trigger the violation.]
+
+- *[No Violation Example]*  : [Optional, Include code snippet which demostrates ideal condition (no violation).]
+
+---
+
+### Rule metadata
+- [*Id*]                : [Should be formatted as `SARIF1nnn`, leave blank if unsure]
+- *Name*                : [Provide a friendly symbolic name for the rule in PascalCase.]
+- *Level*               : [Possible values are: `error`, `warning`, or `note`.]
+- *Full description*    : [Provide atleast two sentences. The first sentence should be a short description of the rule.
+                          This will appear as  `Short Description` in rules metadata. The other sentence(s) should
+                          describe usage of the rule and any other relevant information.]
+
+- User-facing strings:
+  [Each rule has one or more result message strings, each with symbolic name in PascalCase.]
+
+    - *FirstMessage*    : [Default user facing string.]
+    - *[SecondMessage]* : [Optional, Any conditional user facing string(s).]
+    - *[ThirdMessage]*    : [Optional, Any conditional user facing string(s).]
+
+---
+
+### Links/Additional Information
+*[Optional, any Links/Additional Information.]*
+
+### Implementation Notes
+*[Optional, any suggestions regarding implementation.]*
+
+### How to resolve
+*[Optional, any tips on how to resolve the violation.]*
+
+---

eslint-formatter/.gitignore

@@ -0,0 +1,225 @@
+## Ignore Visual Studio temporary files, build results, and
+## files generated by popular Visual Studio add-ons.
+
+# Dev machine files
+appsettings.local.json
+
+# User-specific files
+*.suo
+*.user
+*.userosscache
+*.sln.docstates
+*.opendb
+*.db
+
+# User-specific files (MonoDevelop/Xamarin Studio)
+*.userprefs
+
+# Build results
+[Dd]ebug/
+[Dd]ebugPublic/
+[Rr]elease/
+[Rr]eleases/
+x64/
+x86/
+bld/
+[Bb]in/
+[Oo]bj/
+
+# Visual Studio 2015 cache/options directory
+.vs/
+
+# Visual Studio 2017 browsing database files
+.BROWSE.VC.DB*
+
+# Visual Studio 2017 Application/Debug properties
+launchSettings.json
+
+# VS Code configuration
+.vscode/
+
+# MSTest test Results
+[Tt]est[Rr]esult*/
+[Bb]uild[Ll]og.*
+
+# NUNIT
+*.VisualState.xml
+TestResult.xml
+
+# Build Results of an ATL Project
+[Dd]ebugPS/
+[Rr]eleasePS/
+dlldata.c
+
+# DNX
+project.lock.json
+artifacts/
+
+*_i.c
+*_p.c
+*_i.h
+*.ilk
+*.meta
+*.obj
+*.pch
+*.pdb
+*.pgc
+*.pgd
+*.rsp
+*.sbr
+*.tlb
+*.tli
+*.tlh
+*.tmp
+*.tmp_proj
+*.log
+*.vspscc
+*.vssscc
+.builds
+*.pidb
+*.svclog
+*.scc
+
+# Chutzpah Test files
+_Chutzpah*
+
+# Visual C++ cache files
+ipch/
+*.aps
+*.ncb
+*.opensdf
+*.sdf
+*.cachefile
+
+# Visual Studio profiler
+*.psess
+*.vsp
+*.vspx
+
+# TFS 2012 Local Workspace
+$tf/
+
+# Guidance Automation Toolkit
+*.gpState
+
+# ReSharper is a .NET coding add-in
+_ReSharper*/
+*.[Rr]e[Ss]harper
+*.DotSettings.user
+
+# JustCode is a .NET coding add-in
+.JustCode
+
+# TeamCity is a build add-in
+_TeamCity*
+
+# DotCover is a Code Coverage Tool
+*.dotCover
+
+# NCrunch
+_NCrunch_*
+.*crunch*.local.xml
+
+# MightyMoose
+*.mm.*
+AutoTest.Net/
+
+# Web workbench (sass)
+.sass-cache/
+
+# Installshield output folder
+[Ee]xpress/
+
+# DocProject is a documentation generator add-in
+DocProject/buildhelp/
+DocProject/Help/*.HxT
+DocProject/Help/*.HxC
+DocProject/Help/*.hhc
+DocProject/Help/*.hhk
+DocProject/Help/*.hhp
+DocProject/Help/Html2
+DocProject/Help/html
+
+# Click-Once directory
+publish/
+
+# Publish Web Output
+*.[Pp]ublish.xml
+*.azurePubxml
+## TODO: Comment the next line if you want to checkin your
+## web deploy settings but do note that will include unencrypted
+## passwords
+#*.pubxml
+
+*.publishproj
+
+# NuGet Packages
+*.nupkg
+# The packages folder can be ignored because of Package Restore
+**/packages/*
+# except build/, which is used as an MSBuild target.
+!**/packages/build/
+# Uncomment if necessary however generally it will be regenerated when needed
+#!**/packages/repositories.config
+
+# Windows Azure Build Output
+csx/
+*.build.csdef
+
+# Windows Store app package directory
+AppPackages/
+
+# Visual Studio cache files
+# files ending in .cache can be ignored
+*.[Cc]ache
+# but keep track of directories ending in .cache
+!*.[Cc]ache/
+
+# Others
+ClientBin/
+[Ss]tyle[Cc]op.*
+~$*
+*~
+*.dbmdl
+*.dbproj.schemaview
+*.pfx
+*.publishsettings
+node_modules/
+orleans.codegen.cs
+
+# RIA/Silverlight projects
+Generated_Code/
+
+# Backup & report files from converting an old project file
+# to a newer Visual Studio version. Backup files are not needed,
+# because we have git ;-)
+_UpgradeReport_Files/
+Backup*/
+UpgradeLog*.XML
+UpgradeLog*.htm
+
+# SQL Server files
+*.mdf
+*.ldf
+
+# Business Intelligence projects
+*.rdl.data
+*.bim.layout
+*.bim_*.settings
+
+# Microsoft Fakes
+FakesAssemblies/
+
+# Node.js Tools for Visual Studio
+.ntvs_analysis.dat
+
+# Visual Studio 6 build log
+*.plg
+
+# Visual Studio 6 workspace options file
+*.opt
+
+# LightSwitch generated files
+GeneratedArtifacts/
+_Pvt_Extensions/
+ModelManifest.xml

eslint-formatter/.nuget/NuGet.exe

@@ -0,0 +1,30 @@
+#!/bin/bash
+#@ECHO off
+#SETLOCAL
+
+Exit()
+{
+    echo
+    echo script %~n0 failed
+    return 1
+}
+
+dotnet restore src/Sarif.Sdk.sln
+
+if [ $? != 0 ]
+then
+    echo nuget restore failed.
+    Exit
+    return $?
+fi
+
+# Once JSchema has been ported to .NET Core, uncomment these lines:
+#
+#dotnet msbuild /verbosity:minimal /target:BuildAndInjectObjectModel src/Sarif/Sarif.csproj /fileloggerparameters:Verbosity=detailed
+#
+#if [ $? != 0 ]
+#then
+#    echo SARIF object model generation failed.
+#    Exit
+#    return $?
+#fi

eslint-formatter/BeforeBuild.sh

@@ -0,0 +1,2 @@
+@echo off
+powershell -ExecutionPolicy RemoteSigned -File %~dp0\scripts\BuildAndTest.ps1 %*