star-destroyer

Pragonauts Star Destroyer

Node.js code removal utility. Suitable to remove blocks of code from a large universal project.

The SD needs destroy.config.hjson in the root of the project.

Example of the config:

{
    blocksInUse: ["block2"],
    blocks: {
        block1: {
            removed: false,
            paths: [
                "directory/block1Directory",
                "block1FileA.js"
            ],
            blockDependencies: ["block2"],
            dependencies: ["smallest", "greatest"],
            devDependencies: ["individual"]
        },
        block2: {
            removed: false,
            dependencies: ["greatest"]
        }
    },
    ignore: [
        "node_modules/**"
    ]
}

Config properties

• blocksInUse - array of block names that should be kept in time of sd destroy call.
• blocks - map of all block configuration objects
• blocks[BLOCKNAME].removed - READ ONLY PROPERTY. Do not edit the property manually
• blocks[BLOCKNAME].paths - array of files and folders that should be all removed in time of block removal
• blocks[BLOCKNAME].blockDependencies - array of block names that are needed by the block
• blocks[BLOCKNAME].dependencies - array of npm module names that are needed by the block
• blocks[BLOCKNAME].devDependencies - array of npm module names that are needed by the block
• ignore - array of glob string paths that should be ignored in time of searching block instances. This increase performance

Commands usage:

sd destroy [BLOCKNAME]

The command will comment all BLOCKNAME instances in the project. That means the SD will:

1. iterate all blocks defined in the config and check if there are no other blocks depending to the block. The dependencies can be stored in blockDependencies property of the block config objects.

2. search the // $$BLOCKNAME in line endings and adds // prefix for all lines
   Example:
   var a = 10; // $$BLOCKNAME
   will be replaced by
   // var a = 10; // $$BLOCKNAME

3. search the {/* $$BLOCKNAME */} in line endings of JSX files and comment the lines
   Example:
   <h1>Some heading</h1> {/* $$BLOCKNAME */}
   will be replaced by
   {/*<h1>Some heading</h1>*/} {/* $$BLOCKNAME */}

4. search the blocks of code started with /** $$BLOCKNAME */ or // $$BLOCKNAME BEGIN and ending with /** $$BLOCKNAME END */ or // $$BLOCKNAME END and comment all non-empty lines in the block.
   Example:

   // $$BLOCK1 BEGIN
   var a = 999;
   console.log('abcdefg');
    
   // $$BLOCK1 END

   will be replaced by

   // $$BLOCK1 BEGIN
   // var a = 999;
   // console.log('abcdefg');
    
   // $$BLOCK1 END

5. search the blocks of code in JSX files started with {/* $$BLOCKNAME */} and ending with {/* $$BLOCKNAME END */} and comment all non-empty lines in the block. Example:

       {/* $$BLOCK1 */}
       <li>Some other BLOCK1 {/*Some inner comment*/} navigation item</li>
    
       {/* $$BLOCK1 END */}

   will be replaced by

       {/* $$BLOCK1 */}
       {/*<li>Some other BLOCK1 {/*Some inner comment*!/ navigation item</li>*/}
    
       {/* $$BLOCK1 END */}

6. rename all files and folders present in the paths directory to have REMOVED_ prefix

7. uninstall all npm modules present in the dependencies and devDependencies WITHOUT --save or --save-dev flag.

sd destroy (without [BLOCKNAME])

The command will read all blocks defined in blocks object and removes all blocks not present in the blocksInUse array.

sd clean

The sd destroy command just comments all removing blocks and renames files. The sd clean is used for final project clean. The command will:

1. find and DELETE all block instances in the project that are marked as removed by previous sd destroy calls.

2. removes the files present in the path property of all previously removed blocks.

3. uninstall all npm modules present in the dependencies and devDependencies WITH --save or --save-dev flag.

4. find and remove comments of all kept block instances

5. remove the destroy.config.hjson file