The eslint-plugin-repo-structure from eduhdm

Add JSON Schema

This is an amazing plugin. I was just wanting to add a JSON schema to it for the .repo-structurerc config file. I couldn't find a CONTRIBUTING.md file so I thought it would be easier to just open an issue. The JSON Schema allows the IDE to autocomplete when you are creating the config

JSON schema:

{
  "$schema": "http://json-schema.org/draft-07/schema",
  "additionalProperties": false,
  "properties": {
    "ignorePatterns": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "root": {
      "oneOf": [
        { "$ref": "#/$defs/id" },
        {
          "$ref": "#/$defs/rule"
        }
      ]
    },
    "rules": {
      "type": "object",
      "patternProperties": {
        "^.*$": {
          "$ref": "#/$defs/rule"
        }
      },
      "additionalProperties": false
    }
  },

  "$defs": {
    "id": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        }
      },
      "required": ["id"]
    },
    "rule": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "extension": {
          "oneOf": [
            { "type": "string" },
            { "type": "array", "items": { "type": "string" } }
          ]
        },
        "case": {
          "enum": [
            "PascalCase",
            "camelCase",
            "snake_case",
            "kebab-case",
            "dash-case"
          ]
        },
        "children": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/id_rule"
          },
          "additionalItems": false
        },
        "type": {
          "enum": ["file", "folder"]
        }
      },
      "additionalProperties": false
    },
    "id_rule": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "extension": {
          "oneOf": [
            { "type": "string" },
            { "type": "array", "items": { "type": "string" } }
          ]
        },
        "case": {
          "enum": [
            "PascalCase",
            "camelCase",
            "snake_case",
            "kebab-case",
            "dash-case"
          ]
        },
        "children": {
          "type": "array",
          "items": {
            "oneOf": [{ "$ref": "#/$defs/id_rule" }, { "$ref": "#/$defs/id" }]
          },
          "additionalItems": false
        },
        "type": {
          "enum": ["file", "folder"]
        }
      },
      "additionalProperties": false
    }
  }
}

Deep validation beneath a folder

Hello there!

This plugin is exactly what I need, except for one small thing. I need to validate all folders and files recursively.

I have a main folder pages. This folder may have any number of descendants, for instance: pages/my/grand/grand/grand/child and so on. But every descendant must be named on kebab-case.

Is there a way to achieve this?

Plugin does not work on windows. Use path.sep insted of "/".

import path from "path";

Change all "/" to path.sep in validatePath, filterRulesByType, validateRulesList

eduhdm / eslint-plugin-repo-structure Goto Github PK

eslint-plugin-repo-structure's People

Contributors

Stargazers

Watchers

Forkers

eslint-plugin-repo-structure's Issues

Add JSON Schema

Deep validation beneath a folder

Plugin does not work on windows. Use path.sep insted of "/".

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent