Git Product home page Git Product logo

project-file-saver's Introduction

Project File Saver

This script saves the content of all project files to a single output file. It supports specifying output file name, ignoring specific files and folders, and scanning nested directories.

Table of Contents

Features

  1. Save all project files content to an output file.
  2. Exclude current bash script file.
  3. Get output file name with --output filename.md argument.
  4. Get ignored files and folders with --ignore argument.
  5. Script scans all project files, including nested folders and files.
  6. If the user does not define the --output file name, the default file name is "data.txt".

Usage

Prerequisites

To make the save.sh script executable on your computer, you need to set the executable permission for the file. You can do this using the chmod command. Here's how:

chmod +x save.sh

Examples

Example 1: Save all project files as data.txt

This command will run the script without specifying any ignored files or output file name. The script will use the default output file name, data.txt.

test@computer % ./save.sh   

Example 2: Save all project files as my_data.md

This command will run the script and specify an output file name, my_data.md.

test@computer % ./save.sh   --output my_data.md

Example 3: Save all files except __test__ folder and package-lock.json as summarize.md

This command will run the script, ignoring the __test__ folder and package-lock.json file. The output file will be named summarize.md.

test@computer % ./save.sh  --ignore __test__ package-lock.json  --output summarize.md

Example 4: Save all files except specified files and folders as placeholder_documentation.md

This command will run the script, ignoring node_modules, package.json, webpack.config.js, src, __tests__, package-lock.json, and LICENSE. The output file will be named placeholder_documentation.md.

test@computer % ./save.sh --ignore node_modules package.json webpack.config.js src __tests__ package-lock.json LICENSE --output placeholder_documentation.md

License

License

project-file-saver's People

Contributors

mustafadalga avatar

Stargazers

 avatar  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.