Merge pull request #74 from nanoframework/release-v1.0.0

release-v1.0.0

Author: josesimoes

.github/workflows/update-dependencies.yml

@@ -0,0 +1,52 @@
+# Copyright (c) .NET Foundation and Contributors
+# See LICENSE file in the project root for full license information.
+
+# This workflow will periodically check .NET nanoFramework dependencies and updates them in the repository it's running.
+
+name: Daily update dependencies
+
+on:
+  schedule:
+  # At 00:00 UTC every day.
+  - cron:  '00 00 * * *'
+  repository_dispatch:
+    types: update-dependencies
+
+defaults:
+  run:
+    shell: pwsh
+
+jobs:
+  update-dotnet-preview:
+    name: Update .NET nanoFramework dependencies
+    timeout-minutes: 15
+    runs-on: windows-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          path: main
+      - name: Checkout tools repo
+        uses: actions/checkout@v2
+        with:
+          repository: nanoframework/nf-tools
+          path: tools
+      - name: Update dependencies
+        run: ./github-actions/update-nf-dependencies.ps1
+        working-directory: tools
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v3
+        if: env.CREATE_PR == 'true'
+        with:
+          title: '${{ env.PR_TITLE }}'
+          body: |
+            ${{ env.PR_MESSAGE }}
+            
+            [version update]
+            
+            ### :warning: This is an automated update. :warning:
+          committer: 'nfbot <[email protected]>'
+          branch: ${{ env.BRANCH_NAME }}
+          path: main
+          labels: |
+            Type: dependencies

.gitignore

@@ -255,3 +255,9 @@ paket-files/
 
 #SoundCloud
 *.sonarqube/
+
+#VS Code
+.vscode
+
+#Sonar Lint
+.sonarlint

CHANGELOG.md

@@ -1,3 +1,3 @@
 # Contributor Code of Conduct
 
-Please refer to the contributor Code of Conduct at the Home repository [here](https://github.com/nanoframework/Home/blob/master/CODE_OF_CONDUCT.md.
+Please refer to the contributor Code of Conduct at the Home repository [here](https://github.com/nanoframework/Home/blob/main/CODE_OF_CONDUCT.md.

CODE_OF_CONDUCT.md

@@ -1,3 +1,3 @@
 # Contributing to **nanoFramework**
 
-Please refer to the contribution guidelines at the Home repository [here](https://github.com/nanoframework/Home/blob/master/CONTRIBUTING.md).
+Please refer to the contribution guidelines at the Home repository [here](https://github.com/nanoframework/Home/blob/main/CONTRIBUTING.md).

CONTRIBUTING.md

@@ -1,21 +1,21 @@
-[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=nanoframework_nanoFramework.nanoFramework.Logging&metric=alert_status)](https://sonarcloud.io/dashboard?id=nanoframework_nanoFramework.nanoFramework.Logging) [![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=nanoframework_nanoFramework.nanoFramework.Logging&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=nanoframework_nanoFramework.nanoFramework.Logging) [![License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE) [![NuGet](https://img.shields.io/nuget/dt/nanoFramework.nanoFramework.Logging.svg?label=NuGet&style=flat&logo=nuget)](https://www.nuget.org/packages/nanoFramework.nanoFramework.Logging/) [![#yourfirstpr](https://img.shields.io/badge/first--timers--only-friendly-blue.svg)](https://github.com/nanoframework/Home/blob/master/CONTRIBUTING.md) [![Discord](https://img.shields.io/discord/478725473862549535.svg?logo=discord&logoColor=white&label=Discord&color=7289DA)](https://discord.gg/gCyBu8T)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=nanoframework_nanoFramework.Logging&metric=alert_status)](https://sonarcloud.io/dashboard?id=nanoframework_nanoFramework.Logging) [![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=nanoframework_nanoFramework.Logging&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=nanoframework_nanoFramework.Logging) [![License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE) [![NuGet](https://img.shields.io/nuget/dt/nanoFramework.Logging.svg?label=NuGet&style=flat&logo=nuget)](https://www.nuget.org/packages/nanoFramework.Logging/) [![#yourfirstpr](https://img.shields.io/badge/first--timers--only-friendly-blue.svg)](https://github.com/nanoframework/Home/blob/main/CONTRIBUTING.md) [![Discord](https://img.shields.io/discord/478725473862549535.svg?logo=discord&logoColor=white&label=Discord&color=7289DA)](https://discord.gg/gCyBu8T)
 
-![nanoFramework logo](https://github.com/nanoframework/Home/blob/master/resources/logo/nanoFramework-repo-logo.png)
+![nanoFramework logo](https://raw.githubusercontent.com/nanoframework/Home/main/resources/logo/nanoFramework-repo-logo.png)
 
 -----
 
-### Welcome to the **nanoFramework** nanoFramework.Logging Library repository!
+### Welcome to the .NET **nanoFramework** nanoFramework.Logging Library repository
 
 ## Build status
 
 | Component | Build Status | NuGet Package |
 |:-|---|---|
-| nanoFramework.Logging | [![Build Status](https://dev.azure.com/nanoframework/nanoFramework.nanoFramework.Logging/_apis/build/status/nanoframework.nanoFramework.nanoFramework.Logging?branchName=master)](https://dev.azure.com/nanoframework/nanoFramework.nanoFramework.Logging/_build/latest?definitionId=12?branchName=master) | [![NuGet](https://img.shields.io/nuget/v/nanoFramework.nanoFramework.Logging.svg?label=NuGet&style=flat&logo=nuget)](https://www.nuget.org/packages/nanoFramework.nanoFramework.Logging/) |
-| nanoFramework.Logging (preview) | [![Build Status](https://dev.azure.com/nanoframework/nanoFramework.nanoFramework.Logging/_apis/build/status/nanoframework.nanoFramework.nanoFramework.Logging?branchName=develop)](https://dev.azure.com/nanoframework/nanoFramework.nanoFramework.Logging/_build/latest?definitionId=12?branchName=develop) | [![](https://badgen.net/badge/NuGet/preview/D7B023?icon=https://simpleicons.now.sh/azuredevops/fff)](https://dev.azure.com/nanoframework/feed/_packaging?_a=package&feed=sandbox&package=nanoFramework.nanoFramework.Logging&protocolType=NuGet&view=overview) |
-| nanoFramework.Logging.Serial | [![Build Status](https://dev.azure.com/nanoframework/nanoFramework.nanoFramework.Logging/_apis/build/status/nanoframework.nanoFramework.nanoFramework.Logging?branchName=master)](https://dev.azure.com/nanoframework/nanoFramework.nanoFramework.Logging/_build/latest?definitionId=12?branchName=master) | [![NuGet](https://img.shields.io/nuget/v/nanoFramework.nanoFramework.Logging.Serial.svg?label=NuGet&style=flat&logo=nuget)](https://www.nuget.org/packages/nanoFramework.nanoFramework.Logging.Serial/) |
-| nanoFramework.Logging.Serial (preview) | [![Build Status](https://dev.azure.com/nanoframework/nanoFramework.nanoFramework.Logging/_apis/build/status/nanoframework.nanoFramework.nanoFramework.Logging?branchName=develop)](https://dev.azure.com/nanoframework/nanoFramework.nanoFramework.Logging/_build/latest?definitionId=12?branchName=develop) | [![](https://badgen.net/badge/NuGet/preview/D7B023?icon=https://simpleicons.now.sh/azuredevops/fff)](https://dev.azure.com/nanoframework/feed/_packaging?_a=package&feed=sandbox&package=nanoFramework.nanoFramework.Logging.Serial&protocolType=NuGet&view=overview) |
-| nanoFramework.Logging.Stream | [![Build Status](https://dev.azure.com/nanoframework/nanoFramework.nanoFramework.Logging/_apis/build/status/nanoframework.nanoFramework.nanoFramework.Logging?branchName=master)](https://dev.azure.com/nanoframework/nanoFramework.nanoFramework.Logging/_build/latest?definitionId=12?branchName=master) | [![NuGet](https://img.shields.io/nuget/v/nanoFramework.nanoFramework.Logging.Stream.svg?label=NuGet&style=flat&logo=nuget)](https://www.nuget.org/packages/nanoFramework.nanoFramework.Logging.Stream/) |
-| nanoFramework.Logging.Stream (preview) | [![Build Status](https://dev.azure.com/nanoframework/nanoFramework.nanoFramework.Logging/_apis/build/status/nanoframework.nanoFramework.nanoFramework.Logging?branchName=develop)](https://dev.azure.com/nanoframework/nanoFramework.nanoFramework.Logging/_build/latest?definitionId=12?branchName=develop) | [![](https://badgen.net/badge/NuGet/preview/D7B023?icon=https://simpleicons.now.sh/azuredevops/fff)](https://dev.azure.com/nanoframework/feed/_packaging?_a=package&feed=sandbox&package=nanoFramework.nanoFramework.Logging.Stream&protocolType=NuGet&view=overview) |
+| nanoFramework.Logging | [![Build Status](https://dev.azure.com/nanoframework/nanoframework.Logging/_apis/build/status/nanoframework.nanoFramework.Logging?branchName=main)](https://dev.azure.com/nanoframework/nanoframework.Logging/_build/latest?definitionId=71&branchName=main) | [![NuGet](https://img.shields.io/nuget/v/nanoFramework.Logging.svg?label=NuGet&style=flat&logo=nuget)](https://www.nuget.org/packages/nanoFramework.Logging/) |
+| nanoFramework.Logging (preview) | [![Build Status](https://dev.azure.com/nanoframework/nanoframework.Logging/_apis/build/status/nanoframework.nanoFramework.Logging?branchName=develop)](https://dev.azure.com/nanoframework/nanoframework.Logging/_build/latest?definitionId=71&branchName=develop) | [![NuGet](https://img.shields.io/nuget/vpre/nanoFramework.Logging.svg?label=NuGet&style=flat&logo=nuget)](https://www.nuget.org/packages/nanoFramework.Logging/) |
+| nanoFramework.Logging.Serial | [![Build Status](https://dev.azure.com/nanoframework/nanoframework.Logging/_apis/build/status/nanoframework.nanoFramework.Logging?branchName=main)](https://dev.azure.com/nanoframework/nanoframework.Logging/_build/latest?definitionId=71&branchName=main) | [![NuGet](https://img.shields.io/nuget/v/nanoFramework.Logging.Serial.svg?label=NuGet&style=flat&logo=nuget)](https://www.nuget.org/packages/nanoFramework.Logging.Serial/) |
+| nanoFramework.Logging.Serial (preview) | [![Build Status](https://dev.azure.com/nanoframework/nanoframework.Logging/_apis/build/status/nanoframework.nanoFramework.Logging?branchName=develop)](https://dev.azure.com/nanoframework/nanoframework.Logging/_build/latest?definitionId=71&branchName=develop) | [![NuGet](https://img.shields.io/nuget/vpre/nanoFramework.Logging.Serial.svg?label=NuGet&style=flat&logo=nuget)](https://www.nuget.org/packages/nanoFramework.Logging.Serial/) |
+| nanoFramework.Logging.Stream | [![Build Status](https://dev.azure.com/nanoframework/nanoframework.Logging/_apis/build/status/nanoframework.nanoFramework.Logging?branchName=main)](https://dev.azure.com/nanoframework/nanoframework.Logging/_build/latest?definitionId=71&branchName=main) | [![NuGet](https://img.shields.io/nuget/v/nanoFramework.Logging.Stream.svg?label=NuGet&style=flat&logo=nuget)](https://www.nuget.org/packages/nanoFramework.Logging.Stream/) |
+| nanoFramework.Logging.Stream (preview) | [![Build Status](https://dev.azure.com/nanoframework/nanoframework.Logging/_apis/build/status/nanoframework.nanoFramework.Logging?branchName=develop)](https://dev.azure.com/nanoframework/nanoframework.Logging/_build/latest?definitionId=71&branchName=develop) | [![NuGet](https://img.shields.io/nuget/vpre/nanoFramework.Logging.Stream.svg?label=NuGet&style=flat&logo=nuget)](https://www.nuget.org/packages/nanoFramework.Logging.Stream/) |
 
 
 ## Feedback and documentation
@@ -26,7 +26,7 @@ Join our Discord community [here](https://discord.gg/gCyBu8T).
 
 ## Credits
 
-The list of contributors to this project can be found at [CONTRIBUTORS](https://github.com/nanoframework/Home/blob/master/CONTRIBUTORS.md).
+The list of contributors to this project can be found at [CONTRIBUTORS](https://github.com/nanoframework/Home/blob/main/CONTRIBUTORS.md).
 
 ## License
 
@@ -109,8 +109,8 @@ Note that you can adjust the baud speed and all other elements.
 Or directly using a SerialLogger:
 
 ```csharp
-SerialDevice _serial;
-_serial = SerialDevice.FromId("COM6", 115200);
+SerialPort _serial;
+_serial = new SerialPort("COM6", 115200);
 SerialLogger _logger = new SerialLogger(ref _serial);
 _logger.MinLogLevel = LogLevel.Trace; 
 _logger.LogTrace("This is a trace");
@@ -174,9 +174,71 @@ _logger.LogTrace("This won't be displayed, only critical will be");
 _logger.LogCritical("Critical message will be displayed");
 ```
 
+### Create your own formatting
+
+You can use a custom formatter which will give you the name of the logger, the log level, the event ID, the message itself and a potential exception. The function definition should follow the following pattern:
+
+```csharp
+public interface IMessageFormatter
+{     
+    string MessageFormatter(string className, LogLevel logLevel, EventId eventId, string state, Exception exception);
+}
+```
+
+**Important**: this function will be called directly, without instantiating the class it is part of. So make sure either this function is a static, either it's part of the class using the logger. The static option always works. The interface is given for convenience and to give the format.
+
+To setup the formatting, just use the following line. The type of the class containing the function and the exact name of the function are required.
+
+```csharp
+LoggerExtensions.MessageFormatter = typeof(MyFormatter).GetType().GetMethod("MessageFormatterStatic");
+
+public class MyFormatter
+{        
+    public string MessageFormatterStatic(string className, LogLevel logLevel, EventId eventId, string state, Exception exception)
+    {
+        string logstr = string.Empty;
+        switch (logLevel)
+        {
+            case LogLevel.Trace:
+                logstr = "TRACE: ";
+                break;
+            case LogLevel.Debug:
+                logstr = "I love debug: ";
+                break;
+            case LogLevel.Warning:
+                logstr = "WARNING: ";
+                break;
+            case LogLevel.Error:
+                logstr = "ERROR: ";
+                break;
+            case LogLevel.Critical:
+                logstr = "CRITICAL:";
+                break;
+            case LogLevel.None:
+            case LogLevel.Information:
+            default:
+                break;
+        }
+
+        string eventstr = eventId.Id != 0 ? $" Event ID: {eventId}, " : string.Empty;
+        string msg = $"[{className}] {eventstr}{logstr} {state}";
+        if (exception != null)
+        {
+            msg += $" {exception}";
+        }
+
+        return msg;
+    }
+}
+```
+
+You are free to use anything you'd like and format as you like the message.
+
+Note: It is **not** necessary to add a \r\n at the end, this is done by each logger.
+
 ## Code of Conduct
 
-This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community.
+This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behaviour in our community.
 For more information see the [.NET Foundation Code of Conduct](https://dotnetfoundation.org/code-of-conduct).
 
 ### .NET Foundation

README.md

@@ -0,0 +1,114 @@
+using nanoFramework.TestFramework;
+using System;
+using System.Diagnostics;
+using nanoFramework.Logging;
+using Microsoft.Extensions.Logging;
+using nanoFramework.Logging.Debug;
+
+namespace UnitTestDebugLogging
+{
+    [TestClass]
+    class FormattingTest
+    {
+        static DebugLogger _logger;
+
+        [Setup]
+        public void SteupFormattingTest()
+        {
+            _logger = new DebugLogger(nameof(FormattingTest));
+            LoggerExtensions.MessageFormatter = typeof(MyFormatter).GetType().GetMethod("MessageFormatterStatic");
+            Debug.WriteLine($"{LoggerExtensions.MessageFormatter.Name}");
+            _logger.MinLogLevel = LogLevel.Trace;
+        }
+
+        [TestMethod]
+        public void TestInvoke()
+        {
+            string msg = (string)LoggerExtensions.MessageFormatter.Invoke(null, new object[] { "test", LogLevel.Trace, new EventId(0), "some text", null });
+            Debug.WriteLine(msg);
+        }
+
+        [TestMethod]
+        public void TestFormatting()
+        {
+            LogAll();
+        }
+
+        [TestMethod]
+        public void TestFormattingSimple()
+        {
+            LoggerExtensions.MessageFormatter = typeof(MyFormatter).GetType().GetMethod("MessageFormatterSimple");            
+            LogAll();
+        }
+
+        private void LogAll()
+        {
+            Debug.WriteLine($"Expexcted level: {_logger.MinLogLevel}");
+            _logger.LogTrace("{0} {1}", new object[] { "param 1", 42 });
+            _logger.LogDebug("{0} {1}", new object[] { "param 1", 42 });
+            _logger.LogInformation("Just some information and nothing else");
+            _logger.LogWarning("{0} {1}", new object[] { "param 1", 42 });
+            _logger.LogError(new Exception("Big problem"), "{0} {1}", new object[] { "param 1", 42 });
+            _logger.LogCritical(42, new Exception("Insane problem"), "{0} {1}", new object[] { "param 1", 42 });
+        }
+
+        [Cleanup]
+        public void CleanupFormattingTest()
+        {
+            LoggerExtensions.MessageFormatter = null;
+        }
+    }
+
+    public class MyFormatter : IMessageFormatter
+    {
+        public string MessageFormatter(string className, LogLevel logLevel, EventId eventId, string state, Exception exception)
+            => MessageFormatterStatic(className, logLevel, eventId, state, exception);
+
+        public string MessageFormatterStatic(string className, LogLevel logLevel, EventId eventId, string state, Exception exception)
+        {
+            string logstr = string.Empty;
+            switch (logLevel)
+            {
+                case LogLevel.Trace:
+                    logstr = "TRACE: ";
+                    break;
+                case LogLevel.Debug:
+                    logstr = "I love debug: ";
+                    break;
+                case LogLevel.Warning:
+                    logstr = "WARNING: ";
+                    break;
+                case LogLevel.Error:
+                    logstr = "ERROR: ";
+                    break;
+                case LogLevel.Critical:
+                    logstr = "CRITICAL:";
+                    break;
+                case LogLevel.None:
+                case LogLevel.Information:
+                default:
+                    break;
+            }
+
+            string eventstr = eventId.Id != 0 ? $" Event ID: {eventId}, " : string.Empty;
+            string msg = $"[{className}] {eventstr}{logstr} {state}";
+            if (exception != null)
+            {
+                msg += $" {exception}";
+            }
+
+            return msg;
+        }
+
+        public string MessageFormatterSimple(string className, LogLevel logLevel, EventId eventId, string state, Exception exception)
+        {
+            string msg = $"[{className}] {logLevel}-{state}";
+            if (exception != null)
+            {
+                msg += $" {exception}";
+            }
+
+            return msg;
+        }
+    }
+}

Tests/UnitTestDebugLogging/FormattingTest.cs

@@ -27,7 +27,7 @@ public void TestStreamFile()
             memoryStream.Read(fsContent, 0, fsContent.Length);
             var fsText = Encoding.UTF8.GetString(fsContent, 0, fsContent.Length);
             Assert.StartsWith("An informative message", fsText);
-            Assert.EndsWith("With exception context System.Exception: Something is not supported", fsText);
+            Assert.EndsWith("With exception context System.Exception: Something is not supported\r\n", fsText);
         }
 
         [Cleanup]

Tests/UnitTestDebugLogging/MemoryStreamTests.cs

@@ -11,7 +11,7 @@ namespace UnitTestDebugLogging
 {
     internal class MyTestComponent
     {
-        private ILogger _logger;
+        private readonly ILogger _logger;
 
         public MyTestComponent()
         {