Merge pull request #338 from notion-dotnet/336-add-lint-step-in-build-pipeline

Add lint step in build pipeline 💚

Author: KoditkarVedant

.editorconfig

@@ -0,0 +1,11 @@
+#!/bin/bash
+
+dotnet jb inspectcode Notion.sln -f="Text" --no-build --include="**.cs" -o=".lint/CodeWarningResults.txt"
+
+totalLines=$(file .lint/CodeWarningResults.txt | nl | wc -l)
+
+if [[ "$totalLines" -gt 1 ]]; then
+    echo "There are few linter warnings - please fix them before running the pipeline"
+    cat .lint/CodeWarningResults.txt
+    exit 1
+fi

.github/scripts/check.sh

@@ -21,15 +21,15 @@ jobs:
       - name: Restore dependencies
         run: dotnet restore
 
-      # Format the output of dotnet format
-      - name: Add dotnet-format problem matcher
-        uses: xt0rted/dotnet-format-problem-matcher@v1
-
       # Install dotnet format as a global tool
-      - name: Install dotnet format
+      - name: Install dotnet tools
+        run: dotnet tool restore
+
+      - name: Run Linter
         run: |
-          dotnet tool install --global dotnet-format
-          dotnet format --verify-no-changes --verbosity diagnostic
+          sudo chmod +x ./.github/scripts/check.sh
+          ./.github/scripts/check.sh
+        shell: bash
 
       - name: Build
         run: dotnet build --no-restore

.github/workflows/ci-build.yml

@@ -348,3 +348,9 @@ MigrationBackup/
 
 # Ionide (cross platform F# VS Code tools) working folder
 .ionide/
+
+# Resharper linter
+.lint/
+
+# Rider
+.idea/

.gitignore

@@ -0,0 +1,5 @@
+<wpf:ResourceDictionary xml:space="preserve" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:s="clr-namespace:System;assembly=mscorlib" xmlns:ss="urn:shemas-jetbrains-com:settings-storage-xaml" xmlns:wpf="http://schemas.microsoft.com/winfx/2006/xaml/presentation">
+	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=PDF/@EntryIndexedValue">PDF</s:String>
+	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=API/@EntryIndexedValue">API</s:String>
+	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=JSON/@EntryIndexedValue">JSON</s:String>
+	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=URL/@EntryIndexedValue">URL</s:String></wpf:ResourceDictionary>

Notion.sln.DotSettings

@@ -11,11 +11,6 @@ public static string Retrieve(string databaseId)
                 return $"/v1/databases/{databaseId}";
             }
 
-            public static string List()
-            {
-                return "/v1/databases";
-            }
-
             public static string Query(string databaseId)
             {
                 return $"/v1/databases/{databaseId}/query";
@@ -40,9 +35,9 @@ public static string List()
             }
 
             /// <summary>
-            ///     Get the <see cref="uri string" /> for retrieve your token's bot user.
+            ///     Get the Uri <see cref="string" /> for retrieve your token's bot user.
             /// </summary>
-            /// <returns>Returns a <see cref="uri string" /> retrieve your token's bot user.</returns>
+            /// <returns>Returns a Uri <see cref="string" /> retrieve your token's bot user.</returns>
             public static string Me()
             {
                 return "/v1/users/me";
@@ -62,10 +57,10 @@ public static string Update(string blockId)
             }
 
             /// <summary>
-            ///     Get the <see cref="uri string" /> for deleting a block.
+            ///     Get the Uri <see cref="string" /> for deleting a block.
             /// </summary>
             /// <param name="blockId">Identifier for a Notion block</param>
-            /// <returns>Returns a <see cref="uri string" /> for deleting a block.</returns>
+            /// <returns>Returns a Uri <see cref="string" /> for deleting a block.</returns>
             public static string Delete(string blockId)
             {
                 return $"/v1/blocks/{blockId}";
@@ -105,11 +100,11 @@ public static string UpdateProperties(string pageId)
             }
 
             /// <summary>
-            ///     Get the <see cref="uri string" /> for retrieve page property item
+            ///     Get the Uri <see cref="string" /> for retrieve page property item
             /// </summary>
             /// <param name="pageId">Identifier for a Notion Page</param>
             /// <param name="propertyId">Identifier for a Notion Property</param>
-            /// <returns></returns>
+            /// <returns>Returns a Uri <see cref="string" /> for Retrieve page property item</returns>
             public static string RetrievePropertyItem(string pageId, string propertyId)
             {
                 return $"/v1/pages/{pageId}/properties/{propertyId}";

Src/Notion.Client/Api/ApiEndpoints.cs

@@ -2,7 +2,7 @@
 
 namespace Notion.Client
 {
-    public class AudioUpdateBlock : UpdateBlock, IUpdateBlock
+    public class AudioUpdateBlock : UpdateBlock
     {
         [JsonProperty("audio")]
         public IFileObjectInput Audio { get; set; }

Src/Notion.Client/Api/Blocks/RequestParams/BlocksUpdateParameters/UpdateBlocks/AudioUpdateBlock.cs

@@ -3,7 +3,7 @@
 
 namespace Notion.Client
 {
-    public class BulletedListItemUpdateBlock : UpdateBlock, IUpdateBlock
+    public class BulletedListItemUpdateBlock : UpdateBlock
     {
         [JsonProperty("bulleted_list_item")]
         public Info BulletedListItem { get; set; }

Src/Notion.Client/Api/Blocks/RequestParams/BlocksUpdateParameters/UpdateBlocks/BulletedListItemUpdateBlock.cs

@@ -3,7 +3,7 @@
 
 namespace Notion.Client
 {
-    public class CalloutUpdateBlock : UpdateBlock, IUpdateBlock
+    public class CalloutUpdateBlock : UpdateBlock
     {
         [JsonProperty("callout")]
         public Info Callout { get; set; }

Src/Notion.Client/Api/Blocks/RequestParams/BlocksUpdateParameters/UpdateBlocks/CalloutUpdateBlock.cs

@@ -3,7 +3,7 @@
 
 namespace Notion.Client
 {
-    public class CodeUpdateBlock : UpdateBlock, IUpdateBlock
+    public class CodeUpdateBlock : UpdateBlock
     {
         [JsonProperty("code")]
         public Info Code { get; set; }