Giter Club home page Giter Club logo

editor's Introduction

editor

I swore I made this private but I guess I didn't ๐Ÿ˜† There is nothing here to see yet really, just notes on what this could be.

This is not just a linter, this is an editor to help you write scalable, human-readable code. (Scalable here meaning: to any size of codebase, not to the amount of traffic.)

Because sometimes, when people complain about a framework and its scalability, they are actually complaining about how hard it is to navigate things when things get out of hand. Also sometimes, it's easy to do premature optimization that doesn't actually help -- breaking up a script into modules when it would be more understandable (and therefore maintainable) in a single file.

The interesting thing is that you can do a lot without getting into language specifics -- e.g counting the number of files in a directory, the directory depth in general. You might need it to be configurable to a specific language (a Java project is going to need deeper allowances than a Python one), but the logic is the same. It's also not intended to supplant language-specific linters -- if this tool contradicts any of those more specific tools, please accept those recommendations instead!

Some folks are still going to hate the idea. That's ok! I don't think this is ever going to be a tool for everyone, and I don't think I'd ever encourage, say, having it as a blocking step in a build pipeline. It's purely to help make suggestions about code navigatability and readability! And all such automated suggestions should only be applied with your best judgement -- at the end of the day, you're the human, and you'll always be the best entity to make stylistic judgement calls about your codebase.

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.