Initial release

G1J0SHI · Apr 21, 2022 · 6862d99 · 6862d99
commit 6862d99
Show file tree

Hide file tree

Showing 26 changed files with 3,260 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,22 @@
+*.class
+*.log
+*.pyc
+*.swp
+.DS_Store
+.atom/
+.buildlog/
+.history
+.svn/
+
+*.iml
+*.ipr
+*.iws
+.idea/
+
+.vscode/
+
+/pubspec.lock
+**/doc/api/
+.dart_tool/
+.packages
+build/
diff --git a/.metadata b/.metadata
@@ -0,0 +1,5 @@
+version:
+  revision: 5464c5bac742001448fe4fc0597be939379f88ea
+  channel: stable
+
+project_type: package
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,3 @@
+## 1.0.0
+
+- Initial release.
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2022, G1Joshi
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/README.md b/README.md
@@ -0,0 +1,99 @@
+# Analysis Options for Dart/Flutter
+
+**_The set of rules that encourage good coding practices for applications, packages, and plugins._**
+
+---
+
+## Features
+
+Analyzer and Linting Rules
+
+---
+
+## Getting started
+
+To add the package, `analysis_options`, to an project:
+
+1. Depend on it
+
+   - Add `analysis_options` under `dev_dependencies` in the `pubspec.yaml` file.
+
+2. Install it
+
+   - From the terminal: Run `flutter pub get`.
+
+3. Import it
+
+   - Add a corresponding `include` statement in the YAML code.
+
+---
+
+## Usage
+
+To use the analysis options, add the following dev dependency in your `pubspec.yaml` file:
+
+```yaml
+dev_dependencies:
+  analysis_options: any
+```
+
+Add the following line in your `analysis_options.yaml` file:
+
+```yaml
+include: package:analysis_options/analysis_options.yaml
+```
+
+---
+
+## Additional information
+
+- `Analyzer`: Customize static analysis.
+- `Linter`: Configure linter rules.
+
+### Enabling stricter type checks
+
+```yaml
+analyzer:
+  language:
+    strict-casts: true
+```
+
+### Enabling individual rules
+
+```yaml
+linter:
+  rules:
+    - avoid_print
+```
+
+### Disabling individual rules
+
+```yaml
+linter:
+  rules:
+    public_member_api_docs: false
+```
+
+### Excluding files
+
+```yaml
+analyzer:
+  exclude:
+    - lib/generated_plugin_registrant.dart
+```
+
+### Ignoring rules
+
+```yaml
+analyzer:
+  errors:
+    todo: ignore
+```
+
+### Changing the severity of rules
+
+```yaml
+analyzer:
+  errors:
+    dead_code: info
+```
diff --git a/analysis_options.yaml b/analysis_options.yaml
@@ -0,0 +1 @@
+include: lib/analysis_options.yaml
diff --git a/docs/__404error.html b/docs/__404error.html
@@ -0,0 +1,101 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="viewport" content="width=device-width, height=device-height, initial-scale=1, user-scalable=no">
+  <meta name="generator" content="made with love by dartdoc 4.1.0">
+  <meta name="description" content="analysis_options API docs, for the Dart programming language.">
+  <title>analysis_options - Dart API docs</title>
+
+
+
+  <link rel="preconnect" href="https://fonts.gstatic.com">
+  <link href="https://fonts.googleapis.com/css2?family=Roboto+Mono:ital,wght@0,300;0,400;0,500;0,700;1,400&display=swap" rel="stylesheet">
+  <link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet">
+
+  <link rel="stylesheet" href="static-assets/github.css?v1">
+  <link rel="stylesheet" href="static-assets/styles.css?v1">
+  <link rel="icon" href="static-assets/favicon.png?v1">
+
+
+</head>
+
+
+<body data-base-href=""
+      data-using-base-href="false">
+
+<div id="overlay-under-drawer"></div>
+
+<header id="title">
+  <button id="sidenav-left-toggle" type="button">&nbsp;</button>
+  <ol class="breadcrumbs gt-separated dark hidden-xs">
+    <li><a href="https://G1Joshi.github.io/analysis_options">analysis_options package</a></li>
+  </ol>
+  <div class="self-name">analysis_options</div>
+  <form class="search navbar-right" role="search">
+    <input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
+  </form>
+</header>
+
+<main>
+
+
+  <div id="dartdoc-main-content" class="main-content">
+    <h1>404: Something's gone wrong :-(</h1>
+
+    <section class="desc">
+      <p>You've tried to visit a page that doesn't exist.  Luckily this site
+         has other <a href="index.html">pages</a>.</p>
+      <p>If you were looking for something specific, try searching:
+      <form class="search-body" role="search">
+        <input type="text" id="search-body" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
+      </form>
+      </p>
+
+    </section>
+  </div> <!-- /.main-content -->
+
+  <div id="dartdoc-sidebar-left" class="sidebar sidebar-offcanvas-left">
+    <header id="header-search-sidebar" class="hidden-l">
+  <form class="search-sidebar" role="search">
+    <input type="text" id="search-sidebar" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
+  </form>
+</header>
+
+<ol class="breadcrumbs gt-separated dark hidden-l" id="sidebar-nav">
+  <li><a href="https://G1Joshi.github.io/analysis_options">analysis_options package</a></li>
+</ol>
+
+
+    <h5><span class="package-name">analysis_options</span> <span class="package-kind">package</span></h5>
+    <ol>
+</ol>
+
+  </div>
+
+  <div id="dartdoc-sidebar-right" class="sidebar sidebar-offcanvas-right">
+  </div>
+
+</main>
+
+<footer>
+  <span class="no-break">
+    analysis_options
+      1.0.0
+  </span>
+
+
+</footer>
+
+
+
+<script src="static-assets/highlight.pack.js?v1"></script>
+<script src="static-assets/script.js?v1"></script>
+
+
+
+</body>
+
+</html>
+
diff --git a/docs/categories.json b/docs/categories.json
@@ -0,0 +1 @@
+[]