Lint all files and fix the error in tensorflow-lite WASI-NN plugin. (#95)

Signed-off-by: YiYing He <[email protected]>

Author: q82419

.github/linters/.markdown-lint.yml

@@ -0,0 +1,36 @@
+###########################
+###########################
+## Markdown Linter rules ##
+###########################
+###########################
+
+# Linter rules doc:
+# - https://github.com/DavidAnson/markdownlint
+#
+# Copied from: https://github.com/github/super-linter/blob/main/TEMPLATES/.markdown-lint.yml
+#
+# Note:
+# To comment out a single error:
+#   <!-- markdownlint-disable -->
+#   any violations you want
+#   <!-- markdownlint-restore -->
+#
+
+###############
+# Rules by id #
+###############
+MD004: false                  # Unordered list style
+MD007:
+  indent: 2                   # Unordered list indentation
+MD013:
+  line_length: 999            # Line length 80 is far to short. We allow soft wrapped paragraphs and raw code outputs
+MD026:
+  punctuation: ".,;:!。，；:"  # List of not allowed
+MD029: false                  # Ordered list item prefix
+MD033: false                  # Allow inline HTML
+MD036: false                  # Emphasis used instead of a heading
+
+#################
+# Rules by tags #
+#################
+blank_lines: false  # Error on blank lines

.github/workflows/codeql-analysis.yml

@@ -1,4 +1,3 @@
----
 name: CodeQL Analysis
 
 on:
@@ -22,19 +21,16 @@ jobs:
       actions: read
       contents: read
       security-events: write
-
-  strategy:
-    fail-fast: false
-    matrix:
-      language: ['javascript']
-      steps:
-        - name: Checkout
-          uses: actions/checkout@v3
-
-        - name: Initialize CodeQL
-          uses: github/codeql-action/[email protected]
-          with:
-            languages: ${{ matrix.language }}
-
-        - name: Perform CodeQL Analysis
-          uses: github/codeql-action/[email protected]
+    strategy:
+      fail-fast: false
+      matrix:
+        language: ['javascript']
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Initialize CodeQL
+        uses: github/codeql-action/[email protected]
+        with:
+          languages: ${{ matrix.language }}
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/[email protected]

.github/workflows/lint.yml

@@ -14,38 +14,18 @@ permissions:
   contents: read
 
 jobs:
-  lint:
-    name: Lint
-    timeout-minutes: 30
+  lint-markdown:
+    name: Lint markdown
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout
+      - name: Checkout code
         uses: actions/checkout@v3
 
-      - name: Set up Node
-        uses: actions/setup-node@v3
-        with:
-          node-version: 16.18.0
-          cache: npm
-
-      - name: Cache NPM Dependencies
-        id: cache-npm
-        uses: actions/cache@v3
+      - name: Lint markdown format
+        uses: github/super-linter/slim@v5
         env:
-          cache-name: cache-node-modules
-        with:
-          path: node_modules
-          key: ${{ runner.os }}-node-${{ hashFiles('package-lock.json') }}
-
-      - name: Check Cache
-        if: ${{ steps.cache-npm.outputs.cache-hit != 'true' }}
-        run: npm ci
-
-      - name: Check immutable package-lock
-        run: git diff --exit-code
-
-      - name: Lint
-        run: npm run lint:ci
-
-      - name: Prettier Code
-        run: npm run format:diff
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          DEFAULT_BRANCH: main
+          FILTER_REGEX_INCLUDE: .*docs/.*md$
+          VALIDATE_ALL_CODEBASE: false
+          VALIDATE_MARKDOWN: true

docs/contribute/community.md

@@ -10,10 +10,10 @@ Everyone is welcome to join the WasmEdge community.
 
 If you have any questions, feel free to open a GitHub issue on a related project or to join the following channels:
 
--   Mailing list: Send an email to [[email protected]](https://groups.google.com/g/wasmedge/)
--   Discord: Join the [WasmEdge Discord server](https://discord.gg/h4KDyB8XTt)!
--   Slack: Join the #WasmEdge channel on the [CNCF Slack](https://slack.cncf.io/)
--   Twitter: Follow @realwasmedge on [Twitter](https://twitter.com/realwasmedge)
+- Mailing list: Send an email to [[email protected]](https://groups.google.com/g/wasmedge/)
+- Discord: Join the [WasmEdge Discord server](https://discord.gg/h4KDyB8XTt)!
+- Slack: Join the #WasmEdge channel on the [CNCF Slack](https://slack.cncf.io/)
+- Twitter: Follow @realwasmedge on [Twitter](https://twitter.com/realwasmedge)
 
 ## Community Meeting
 

docs/contribute/contribute.md

@@ -63,8 +63,8 @@ Before opening any issue, please look up the existing [issues](https://github.co
 
 When reporting issues, always include:
 
--   Version of your system
--   Configuration files of WasmEdge
+- Version of your system
+- Configuration files of WasmEdge
 
 Because the issues are open to the public, when submitting the log and configuration files, be sure to remove any sensitive information, e.g. user name, password, IP address, and company name. You can replace those parts with "REDACTED" or other strings like "\*\*\*\*". Be sure to include the steps to reproduce the problem if applicable. It can help us understand and fix your issue faster.
 

docs/contribute/installer.md

@@ -48,115 +48,115 @@ The real installer handles all stuff. It supports python2.7 (not tested on earli
 
 ### Help Msg
 
--   Short Option: `-h`
--   Full Option: `--help`
--   Description: Show this help message and exit.
+- Short Option: `-h`
+- Full Option: `--help`
+- Description: Show this help message and exit.
 
 ### Verbose
 
--   Short Option: `-D`
--   Full Option: `--debug`
--   Description: Enable verbosity debug
+- Short Option: `-D`
+- Full Option: `--debug`
+- Description: Enable verbosity debug
 
 ### Specify the version of WasmEdge to install
 
--   Short Option: `-v VERSION`
--   Full Option: `--version VERSION`
--   Description: Install the given VERSION of WasmEdge
--   Available Value: VERSION `0.11.2` or other valid release versions.
--   Note - In the case of supplied an invalid or nonexistent version, the installer exists with an error.
+- Short Option: `-v VERSION`
+- Full Option: `--version VERSION`
+- Description: Install the given VERSION of WasmEdge
+- Available Value: VERSION `0.11.2` or other valid release versions.
+- Note - In the case of supplied an invalid or nonexistent version, the installer exists with an error.
 
 ### Installation path
 
--   Short Option: `-p PATH`
--   Full Option: `--path PATH`
--   Description: Install WasmEdge into the given PATH. The default Path is `$HOME/.wasmedge`.
--   Note - In any path other than the ones starting with `/usr` are treated as non system paths in the internals of the installer. The consequences are different directory structures for both.
--   Note - If the path not exists, the folder will be created.
+- Short Option: `-p PATH`
+- Full Option: `--path PATH`
+- Description: Install WasmEdge into the given PATH. The default Path is `$HOME/.wasmedge`.
+- Note - In any path other than the ones starting with `/usr` are treated as non system paths in the internals of the installer. The consequences are different directory structures for both.
+- Note - If the path not exists, the folder will be created.
 
 ### Uninstallation
 
 #### Run uninstaller before installing
 
--   Short Option: `-r {yes,no}`
--   Full Option: `--remove-old {yes, no}`
--   Description: Run the uninstaller script before installing. Default `yes`.
+- Short Option: `-r {yes,no}`
+- Full Option: `--remove-old {yes, no}`
+- Description: Run the uninstaller script before installing. Default `yes`.
 
 #### Use a specific version of the uninstaller
 
--   Short Option: `-u UNINSTALL_SCRIPT_TAG`
--   Full Option: `--uninstall-script-tag UNINSTALL_SCRIPT_TAG`
--   Description: Use the given GitHub tag to uninstall the script
+- Short Option: `-u UNINSTALL_SCRIPT_TAG`
+- Full Option: `--uninstall-script-tag UNINSTALL_SCRIPT_TAG`
+- Description: Use the given GitHub tag to uninstall the script
 
 ### Install Extensions
 
--   Short Option: `-e [EXTENSIONS [EXTENSIONS ...]]`
--   Full Option: `--extension [EXTENSIONS [EXTENSIONS ...]]`
--   Description: Install wasmedge-extension tools.
--   Available Value (case sensitive): Supported Extensions `'tensorflow', 'image', 'all'`.
+- Short Option: `-e [EXTENSIONS [EXTENSIONS ...]]`
+- Full Option: `--extension [EXTENSIONS [EXTENSIONS ...]]`
+- Description: Install wasmedge-extension tools.
+- Available Value (case sensitive): Supported Extensions `'tensorflow', 'image', 'all'`.
 
 #### Tensorflow Extensions Library Version
 
--   Full Option: `--tf-version TF_VERSION`
--   Description: Install the given VERSION of the library of the Tensorflow and Tensorflow lite extension. Only available when the `Extensions` is set to `all` or `tensorflow`.
--   Note - It's the same as the WasmEdge version if not specified.
+- Full Option: `--tf-version TF_VERSION`
+- Description: Install the given VERSION of the library of the Tensorflow and Tensorflow lite extension. Only available when the `Extensions` is set to `all` or `tensorflow`.
+- Note - It's the same as the WasmEdge version if not specified.
 
 #### Tensorflow Extensions Dependencies Version
 
--   Full Option: `--tf-deps-version TF_DEPS_VERSION`
--   Description: Install the given VERSION of the dependencies of the Tensorflow and Tensorflow lite extension. Only available when the `Extensions` is set to `all` or `tensorflow`.
--   Note - It's the same as the WasmEdge version if not specified.
+- Full Option: `--tf-deps-version TF_DEPS_VERSION`
+- Description: Install the given VERSION of the dependencies of the Tensorflow and Tensorflow lite extension. Only available when the `Extensions` is set to `all` or `tensorflow`.
+- Note - It's the same as the WasmEdge version if not specified.
 
 #### Tensorflow Extensions Tools Version
 
--   Full Option: `--tf-tools-version TF_TOOLS_VERSION`
--   Description: Install the given VERSION of the tools of the Tensorflow and Tensorflow lite extension. Only available when the `Extensions` is set to `all` or `tensorflow`.
--   Note - It's the same as the WasmEdge version if not specified.
+- Full Option: `--tf-tools-version TF_TOOLS_VERSION`
+- Description: Install the given VERSION of the tools of the Tensorflow and Tensorflow lite extension. Only available when the `Extensions` is set to `all` or `tensorflow`.
+- Note - It's the same as the WasmEdge version if not specified.
 
 #### Image Extensions Version
 
--   Full Option: `--image-version IMAGE_VERSION`
--   Description: Install the given VERSION of the Image extension. Only available when the `Extensions` is set to `all` or `image`.
--   Note - It's the same as the WasmEdge version if not specified.
+- Full Option: `--image-version IMAGE_VERSION`
+- Description: Install the given VERSION of the Image extension. Only available when the `Extensions` is set to `all` or `image`.
+- Note - It's the same as the WasmEdge version if not specified.
 
 ### Plugins
 
--   Note - Currently `--plugins` is an experimental option.
+- Note - Currently `--plugins` is an experimental option.
 
--   Full Option: `--plugins wasi_crypto:0.11.0`
+- Full Option: `--plugins wasi_crypto:0.11.0`
 
--   Note - The format for this argument is `<plugin_name>:<version_number>`. `<version_number>` is not compulsory. For example `--plugins wasi_crypto` is a valid option.
--   Note - `<plugin_name>` is cases sensitive. Allowed values are stated [here](https://wasmedge.org/docs/contribute/plugin/intro) in the `Rust Crate` column. The logic is that the release name should be the same.
--   Note - It's the same as the WasmEdge version if not specified.
+- Note - The format for this argument is `<plugin_name>:<version_number>`. `<version_number>` is not compulsory. For example `--plugins wasi_crypto` is a valid option.
+- Note - `<plugin_name>` is cases sensitive. Allowed values are stated [here](https://wasmedge.org/docs/contribute/plugin/intro) in the `Rust Crate` column. The logic is that the release name should be the same.
+- Note - It's the same as the WasmEdge version if not specified.
 
 ### DIST
 
--   Full Option: `--dist ubuntu20.04` or `--dist manylinux2014`
--   Note - the `ubuntu20.04` and `manylinux2014` values are case insensitive and only these two are currently supported.
--   Note - Specifying `--dist` value for `Darwin` has no effect.
--   Note - For `Linux` platform if the distribution matches exactly as `Ubuntu 20.04` which is checked using `lsb_release` and python's `platform.dist()` functionality then it is set to `ubuntu20.04` if not specified, else it is used without questioning. However different release packages for WasmEdge are available only after `0.11.1` release below which there is no effect of specifying this option.
+- Full Option: `--dist ubuntu20.04` or `--dist manylinux2014`
+- Note - the `ubuntu20.04` and `manylinux2014` values are case insensitive and only these two are currently supported.
+- Note - Specifying `--dist` value for `Darwin` has no effect.
+- Note - For `Linux` platform if the distribution matches exactly as `Ubuntu 20.04` which is checked using `lsb_release` and python's `platform.dist()` functionality then it is set to `ubuntu20.04` if not specified, else it is used without questioning. However different release packages for WasmEdge are available only after `0.11.1` release below which there is no effect of specifying this option.
 
 ### Platform and OS
 
--   Full Option: `--platform PLATFORM` or `--os OS`
--   Description: Install the given `PLATFORM` or `OS` version of WasmEdge. This value should be case insensitive to make the maximum compatibility.
--   Available Value (case insensitive): "Linux", "Darwin", "Windows".
+- Full Option: `--platform PLATFORM` or `--os OS`
+- Description: Install the given `PLATFORM` or `OS` version of WasmEdge. This value should be case insensitive to make the maximum compatibility.
+- Available Value (case insensitive): "Linux", "Darwin", "Windows".
 
 ### Machine and Arch
 
--   Full Option: `--machine MACHINE` or `--arch ARCH`
--   Description: Install the given `MACHINE` or `ARCH` version of WasmEdge.
--   Available Value: "x86_64", "aarch64".
+- Full Option: `--machine MACHINE` or `--arch ARCH`
+- Description: Install the given `MACHINE` or `ARCH` version of WasmEdge.
+- Available Value: "x86_64", "aarch64".
 
 ## Behavior
 
--   If there exists an installation at `$HOME/.wasmedge` which is to be noted as the default installation path, it is removed with or without uninstaller's invocation.
--   WasmEdge installation appends all the files it installs to a file which is located in the installer directory named `env` with it's path as `$INSTALLATION_PATH/env`
+- If there exists an installation at `$HOME/.wasmedge` which is to be noted as the default installation path, it is removed with or without uninstaller's invocation.
+- WasmEdge installation appends all the files it installs to a file which is located in the installer directory named `env` with it's path as `$INSTALLATION_PATH/env`
 
 ### Shell and it's configuration
 
--   Source string in shell configuration is given as `. $INSTALLATION_PATH/env` so that it exports the necessary environment variables for WasmEdge.
--   Shell configuration file is appended with source string if it cannot find the source string in that file.
--   Currently it detects only `Bash` and `zsh` shells.
--   If the above shells are found, then their respective configuration files `$HOME/.bashrc` and `$HOME/.zshrc` are updated along with `$HOME/.zprofile` and `$HOME/.bash_profile` in case of Linux.
--   In case of `Darwin`, only `$HOME/.zprofile` is updated with the source string.
+- Source string in shell configuration is given as `. $INSTALLATION_PATH/env` so that it exports the necessary environment variables for WasmEdge.
+- Shell configuration file is appended with source string if it cannot find the source string in that file.
+- Currently it detects only `Bash` and `zsh` shells.
+- If the above shells are found, then their respective configuration files `$HOME/.bashrc` and `$HOME/.zshrc` are updated along with `$HOME/.zprofile` and `$HOME/.bash_profile` in case of Linux.
+- In case of `Darwin`, only `$HOME/.zprofile` is updated with the source string.

docs/contribute/overview.md

@@ -9,25 +9,25 @@ Contribution is always welcome! The WebAssembly ecosystem is still in its early
 
 To help new contributors understand WasmEdge development workflow, this guide will include
 
--   [Build WasmEdge and WasmEdge plug-in from source on different platforms](/category/build-wasmedge-from-source)
--   [WasmEdge Plug-in system introduction](/category/wasmedge-plugin-system)
--   [Test WasmEdge](test.md)
--   [WasmEdge Fuzzing](fuzzing.md)
--   [WasmEdge internal explanation](internal.md)
--   [WasmEdge installer system explanation](installer.md)
--   [contributing steps](contribute.md)
--   [WasmEdge release process](release.md)
--   [Join WasmEdge community](community.md)
+- [Build WasmEdge and WasmEdge plug-in from source on different platforms](/category/build-wasmedge-from-source)
+- [WasmEdge Plug-in system introduction](/category/wasmedge-plugin-system)
+- [Test WasmEdge](test.md)
+- [WasmEdge Fuzzing](fuzzing.md)
+- [WasmEdge internal explanation](internal.md)
+- [WasmEdge installer system explanation](installer.md)
+- [contributing steps](contribute.md)
+- [WasmEdge release process](release.md)
+- [Join WasmEdge community](community.md)
 
 ## Ideas for contributions
 
 If you're looking for something to contribute, we have issues
 
--   labeled with [`good first issue`](https://github.com/WasmEdge/WasmEdge/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22), which are recommendations for developers to contribute to WasmEdge by working on some easy tasks. These tasks will help contributors to learn the WasmEdge development workflow.
+- labeled with [`good first issue`](https://github.com/WasmEdge/WasmEdge/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22), which are recommendations for developers to contribute to WasmEdge by working on some easy tasks. These tasks will help contributors to learn the WasmEdge development workflow.
 
--   labeled with [`help wanted`](https://github.com/WasmEdge/WasmEdge/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22), for which are we need suggestions and opinions from the community.
+- labeled with [`help wanted`](https://github.com/WasmEdge/WasmEdge/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22), for which are we need suggestions and opinions from the community.
 
--   [Roadmap](https://github.com/WasmEdge/WasmEdge/blob/master/docs/ROADMAP.md) for every year, which elaborates the new features in the coming days. You're also welcome to pick one.
+- [Roadmap](https://github.com/WasmEdge/WasmEdge/blob/master/docs/ROADMAP.md) for every year, which elaborates the new features in the coming days. You're also welcome to pick one.
 
 If you find something is missing, don't hesitate to create an issue and let us know. Again, WasmEdge is open in development.