first commit

.gitignore

@@ -0,0 +1,130 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 raphael kieling tondin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,63 @@
+<div align="center">
+    <img src="image.png" height="100px">
+</div>
+
+# Doctorenv
+
+> 100% WIP, please do not use it yet
+
+Doctorenv is a checklist tool that helps developers identify environment issues and provides suggestions on how to fix them. 🐛
+
+### Why?
+
+Sometimes you aren't sure if you have everything to contribute in a project. The `Doctorenv` should give you some help on:
+
+- Check what is missing in your environment to make it works
+- Giving you some `Suggestions` on how to fix in case you do not met some requirements
+- Easy to start using and change
+- Automatic fixers
+
+Example of config:
+
+```js
+// doctorenv.config.js
+export default [
+  {
+    name: "Has all the environment variables",
+    definitions: [
+      {
+        name: "MY_ENV",
+        suggestions: ["execute in the root: source ./.env.local"],
+        // if the checker is false, shows all the suggestion
+        checker: () => process.env.MY_ENV,
+      },
+    ],
+  },
+];
+```
+
+Run:
+
+```sh
+# To check
+doctorenv check
+
+# To fix (if fixable)
+doctorenv fix
+```
+
+### Programmatic usage:
+
+```js
+import { Builder } from "doctorenv";
+
+new Builder()
+  .createDefinition("Definition 1")
+  .addChecker("has yarn", () => true)
+  .addChecker("has npm", () => true)
+  .start();
+```
+
+<small>
+Temporary Icon from: <a href="https://www.flaticon.com/free-icons/pharmacist" title="Pharmacist icons">Pharmacist icons created by Freepik - Flaticon</a>
+</small>

doctorenv.config.js

@@ -0,0 +1 @@
+export default [];

example.config.js

@@ -0,0 +1,48 @@
+export default [
+  {
+    name: "NPM or YARN",
+    definitions: [
+      {
+        name: "has yarn",
+        suggestions: ["install yarn"],
+        checker: () => true,
+      },
+    ],
+  },
+  {
+    name: "Docker",
+    suggestions: ["Install npm", "Install yarn"],
+    fix: [],
+    definitions: [
+      {
+        name: "has docker",
+        suggestions: ["visit: https://www.docker.com"],
+        checker: ({ definition }) => {
+          console.log(definition);
+          definition.pushSuggestion("Install docker friend");
+          return false;
+        },
+      },
+      {
+        name: "has containerd",
+        suggestions: ["Install the containerd"],
+        checker: () => false,
+      },
+    ],
+  },
+  {
+    name: "Environments",
+    definitions: [
+      {
+        name: "has A",
+        suggestions: ["Run the .source"],
+        checker: () => !!process.env.A,
+      },
+      {
+        name: "has B",
+        suggestions: ["Run the .source"],
+        checker: () => true,
+      },
+    ],
+  },
+];