Giter Club home page Giter Club logo

code-parser's Introduction

code-parser

Library that allows you parse files to interpret functions/statements/classes/other syntax in a variety of languages

Setup:

  1. Node 18.15.0 was used for development
  2. Need to install yarn
  3. Run yarn install to install dependencies
  4. Run yarn test to run tests

Logic breakdown/Roadmap:

There is a few types of information that are relevant that I would like to see.

One is just general metadata information based on where you are scoped. (For now I am scoping to individual files).

So for example:

  1. Information about entire project files
  2. Information about directories
  3. Information about individual files
  4. Information about function/class/other block related elements

The type of information that would be provided for each scope is:

  1. Name of item/element/symbol
  2. Type of item (function, class, etc if block related)
  3. Metadata relevant to scope, like how many lines of code, how many comments, how many statements, functions, etc

The second type of information is the actual parsed information inside of that scope. So the functions which might contain classes/properties/methods, etc...

Roadmap/Current Goals:

  1. Mainly focusing on Typescript/JavaScript for now, but ideally would like to expand to other languages
  2. Create a framework for a generic parser that can be used to parse files for different languages
  3. Focus on providing raw content of different scopes, like file content, lines, function blocks, etc...
  4. Identify different symbols and the scopes that are contained within the file, like functions, classes, etc...
  5. Provide metadata about the scopes, like how many lines of code, how many functions/classes/other symbols, etc...
  6. Provide a way to take the parsed information and use it to identify advanced information

code-parser's People

Contributors

jjosephttg avatar

Watchers

 avatar

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.