lint-report.json

{
  "configuration": {
    "paths": [
      "test_code"
    ],
    "projectType": "sketch",
    "recursive": false
  },
  "projects": [
    {
      "path": "test_code",
      "projectType": "sketch",
      "configuration": {
        "compliance": "specification",
        "libraryManager": "false",
        "official": false
      },
      "rules": [
        {
          "category": "structure",
          "subcategory": "root folder",
          "ID": "SS001",
          "brief": "name mismatch",
          "description": "There is no `.ino` sketch file with name matching the sketch folder. The primary sketch file name must match the folder for the sketch to be valid.",
          "result": "pass",
          "level": "NOTICE",
          "message": ""
        },
        {
          "category": "structure",
          "subcategory": "file name",
          "ID": "SS002",
          "brief": "prohibited character in filename",
          "description": "A sketch file's name contains a prohibited character.",
          "result": "pass",
          "level": "NOTICE",
          "message": ""
        },
        {
          "category": "structure",
          "subcategory": "file name",
          "ID": "SS003",
          "brief": "file name too long",
          "description": "The sketch file's name exceeds the maximum length.",
          "result": "pass",
          "level": "NOTICE",
          "message": ""
        },
        {
          "category": "structure",
          "subcategory": "file name",
          "ID": "SS004",
          "brief": ".pde extension",
          "description": "A sketch file uses the deprecated `.pde` file extension. The .pde extension is used by both [Processing](https://processing.org/) sketches and Arduino sketches. If the project has supplemental Processing sketches, they should either be in the [`data` subfolder of the sketch](https://arduino.github.io/arduino-cli/latest/sketch-specification/#data-subfolder) or in the [`extras` folder of the library](https://arduino.github.io/arduino-cli/latest/library-specification/#extra-documentation). Arduino sketches should use the modern `.ino` extension.",
          "result": "pass",
          "level": "NOTICE",
          "message": ""
        },
        {
          "category": "structure",
          "subcategory": "miscellaneous",
          "ID": "SS005",
          "brief": "src folder case",
          "description": "The sketch's source subfolder name has incorrect case. This folder must be named exactly `src` in order for the contents to be compiled on case sensitive file systems (e.g., Linux).",
          "result": "pass",
          "level": "NOTICE",
          "message": ""
        },
        {
          "category": "code",
          "subcategory": "miscellaneous",
          "ID": "SC001",
          "brief": "Arduino.h case",
          "description": "An `#include` directive for a file matching the standardized Arduino core library's `Arduino.h` header in all except case (e.g., `#include <arduino.h>`) was found in the sketch's code. This causes compilation failure on case-sensitive file systems.",
          "result": "pass",
          "level": "NOTICE",
          "message": ""
        },
        {
          "category": "documentation",
          "subcategory": "miscellaneous",
          "ID": "SD001",
          "brief": "no readme",
          "description": "None of the standard README file names (e.g., `README.md`) were found in the sketch folder. This file provides interested parties with a convenient and standardized location to get information about the project.",
          "result": "fail",
          "level": "WARNING",
          "message": "No readme found. Please document your sketch.\nSee: https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes"
        },
        {
          "category": "documentation",
          "subcategory": "miscellaneous",
          "ID": "SD002",
          "brief": "no license file",
          "description": "None of the standard license file names (e.g., `LICENSE.txt`) were found in the sketch's root folder. This file provides interested parties with a convenient and standardized location to get information about the project's licensing and is also used by GitHub for automatic license type classification.",
          "result": "fail",
          "level": "WARNING",
          "message": "No license file found.\nSee: https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository"
        },
        {
          "category": "sketch.json",
          "subcategory": "general",
          "ID": "SM001",
          "brief": "sketch.json JSON format",
          "description": "The sketch's `sketch.json` metadata file is not a valid JSON document.",
          "result": "skipped",
          "level": "NOTICE",
          "message": "No metadata file"
        },
        {
          "category": "sketch.json",
          "subcategory": "general",
          "ID": "SM002",
          "brief": "sketch.json data format",
          "description": "The sketch's `sketch.json` metadata file does not have a valid data format.",
          "result": "skipped",
          "level": "NOTICE",
          "message": "No metadata file"
        }
      ],
      "summary": {
        "pass": true,
        "warningCount": 2,
        "errorCount": 0
      }
    }
  ],
  "summary": {
    "pass": true,
    "warningCount": 2,
    "errorCount": 0
  }
}