Git Product home page Git Product logo

Comments (2)

Deadly0 avatar Deadly0 commented on May 26, 2024 1

Sorry, it was my mistake. It works as expected

from eslint-plugin-project-structure.

Igorkowalski94 avatar Igorkowalski94 commented on May 26, 2024

By default, all files and folders are optional. Only existing files/folders are validated. If any of them do not meet the project structure conditions, an error is displayed. Unless I didn't understand something. Can you describe your problem in more detail and show an example of the structure?

e.g. for such a structure you can only create a 'hello' folder in the root of your project, but it is optional, so if you do not physically have a 'hello' folder, no error will be displayed. For folders to be checked, they must contain at least one file/folder with file. Empty folders will be ignored by eslint and git.

{
    "structure": {
        "children": [
            {
               // all files in the root of the project
                "extension": "*"
            },
            {
                "name": "hello",
                "children": []
            }
        ]
    }
}

✅ Corrent structure:

.
├── ...
├── 📄 projectStructure.json
├── 📄 .eslintrc.json
└── 📂 hello
    └── 📄 index.tsx

✅ Corrent structure:

.
├── ...
├── 📄 projectStructure.json
└── 📄 .eslintrc.json

❌ Incorrect structure:

.
├── ...
├── 📄 projectStructure.json
├── 📄 .eslintrc.json
└── 📂 someFolderName
    └── 📄 index.tsx

❌ Incorrect structure:

.
├── ...
├── 📄 projectStructure.json
├── 📄 .eslintrc.json
├── 📂 hello
│   └── 📄 index.tsx
└── 📂 someFolderName
    └── 📄 index.tsx

from eslint-plugin-project-structure.

Related Issues (4)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.