destiny

Prettier for File Structures

0.0.14

source

npm

Version published: 4 years ago

Maintainers: 1

Created: 10 years ago

Readme

Source

destiny

Prettier for File Structures

Motivation: https://www.youtube.com/watch?v=rGYbrIf-y58

example transformation

What does this do?

Scans a folder for all the files in it
Creates a directed graph based on how the JavaScript/TypeScript files import each other
Creates a fractal representation of the graph (following similar rules outlined here: https://hackernoon.com/fractal-a-react-app-structure-for-infinite-scale-4dab943092af)
Moves existing files into the fractal structure
Fixes imports
Removes all empty folders
Prints files that are "unused" (not imported by anyone and doesn't import anything)

The end result is a "prettified" file structure.

Disclaimer

This is a work in progress and 100% has bugs of some kind in it
BEFORE running this tool on your codebase, make sure you have commited to git or made a backup (I don't expect the tool to destroy your work (although it's possible), but just in case you don't like the results)
Snapshot tests don't format correctly
Only works on JavaScript/TypeScript codebases (althought this concept could probably be extended to any language)

How to run it

npx destiny src/**/*.*

This tool might be useless

It might be better to just name your folders.

Why did you name it destiny?

The name could be "Destiny" maybe. Like the file was meant to be there.

Contributing

pull requests are welcome :)

FAQs

What is destiny?

Is destiny well maintained?

Last updated on 16 Feb 2020

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install