Craft-gitignore 🧰

Craft-gitignore is your trusty companion for effortlessly generating .gitignore files tailored to your project's needs. Say goodbye to manual .gitignore file creation and hello to streamlined version control.

Craft-gitignore analyzes your code directory and creates a comprehensive .gitignore file with rules specific to the programming languages, operating systems, and common file types in your project. 🚀

Features

• 📦 Language Support: Craft-gitignore supports a wide range of programming languages, ensuring that your project's dependencies and build artifacts are excluded from version control.

  • AL, Ada, Agda, C++, C, CMake, Clojure, Coq, D, DM, Dart, Eagle, Elixir, Elm, Erlang, Fancy, Fortran, Go, Gradle, Haskell, Idris, Java, JavaScript, Kotlin, LabVIEW, Lua, Mercury, Nim, OCaml, Objective-C, Perl, Processing, PureScript, Python, R, Racket, Ruby, Rust, Sass, Scala, Scheme, Smalltalk, Swift, TeX, Xojo, Zephir, and more!

• 🖥 Operating System Support: Craft-gitignore supports a wide range of operating systems, ensuring that your project's system files are excluded from version control. It currently supports all MacOS, Windows, and Linux operating systems.

• 📝 Text Editors and IDE Support: Craft-gitignore supports a wide range of text editors and IDEs, ensuring that your project's editor and IDE configuration files are excluded from version control.

  • Vim, Visual Studio Code, Atom, JetBrains IDEs, and more!

• 🧰 Miscellaneous Support: Craft-gitignore supports a wide range of miscellaneous file types, ensuring that your project's miscellaneous files are excluded from version control.

  • Archives, Backup files, and more!

Getting Started

Installation

Start by installing the Craft-gitignore npm package globally:

$  npm install -g craft-gitignore

Note: You may need to use sudo for installation, depending on your system's permissions.

Usage:

Simply, run the following command in your project's root directory:

$  craft-gitignore

Optionally, you can specify a different directory to analyze by providing it as an argument:

$  craft-gitignore /path/to/directory

Note: If no directory is specified, the current working directory will be used. Note: The path can be either absolute or relative. So, you can use craft-gitignore ./src for example.

Contributing 🤝

Found a bug? Have an idea for an improvement? Contributions to Craft-gitignore are more than welcome! Feel free to open issues, create pull requests, or suggest new features.

License 📜

This project is open-source and available under the MIT License. You are free to use, modify, and distribute it as you see fit.

For more details, please refer to the LICENSE file.

Happy coding! 🚀