Gitignore Basic Setup

robotpy_installer/cli_init.py

@@ -36,3 +36,10 @@ def run(self, main_file: pathlib.Path, project_path: pathlib.Path):
             pyproject.write_default_pyproject(project_path)
 
             logger.info("Created %s", pyproject_path)
+
+        # Create .gitignore if it doesn't already exist
+        gitignore_path = pyproject.gitignore_path(project_path)
+        if not gitignore_path.exists():
+            pyproject.write_default_gitignore(gitignore_path)
+
+            logger.info("Created %s", gitignore_path)

robotpy_installer/pyproject.py

@@ -31,6 +31,10 @@ def toml_path(project_path: pathlib.Path):
     return project_path / "pyproject.toml"
 
 
+def gitignore_path(project_path: pathlib.Path):
+    return project_path / ".gitignore"
+
+
 @dataclasses.dataclass
 class RobotPyProjectToml:
     """
@@ -123,6 +127,250 @@ def robotpy_installed_version() -> str:
         ) from None
 
 
+def write_default_gitignore(project_path: pathlib.Path):
+    """
+    Using the current environment, write a basic .gitignore file
+
+    :param project_path: Path to robot project
+    """
+
+    ignore_content = inspect.cleandoc(
+        """
+    # Log file
+    *.log
+
+    ### Linux ###
+    *~
+
+    # temporary files which can be created if a process still has a handle open of a deleted file
+    .fuse_hidden*
+
+    # KDE directory preferences
+    .directory
+
+    # Linux trash folder which might appear on any partition or disk
+    .Trash-*
+
+    # .nfs files are created when an open file is removed but is still being accessed
+    .nfs*
+
+    ### macOS ###
+    # General
+    .DS_Store
+    .AppleDouble
+    .LSOverride
+
+    # Icon must end with two \r
+    Icon
+
+    # Thumbnails
+    ._*
+
+    # Files that might appear in the root of a volume
+    .DocumentRevisions-V100
+    .fseventsd
+    .Spotlight-V100
+    .TemporaryItems
+    .Trashes
+    .VolumeIcon.icns
+    .com.apple.timemachine.donotpresent
+
+    # Directories potentially created on remote AFP share
+    .AppleDB
+    .AppleDesktop
+    Network Trash Folder
+    Temporary Items
+    .apdisk
+
+    ### VisualStudioCode ###
+    .vscode/*
+    !.vscode/settings.json
+    !.vscode/tasks.json
+    !.vscode/launch.json
+    !.vscode/extensions.json
+
+    ### Windows ###
+    # Windows thumbnail cache files
+    Thumbs.db
+    ehthumbs.db
+    ehthumbs_vista.db
+
+    # Dump file
+    *.stackdump
+
+    # Folder config file
+    [Dd]esktop.ini
+
+    # Recycle Bin used on file shares
+    $RECYCLE.BIN/
+
+    # IntelliJ
+    .idea/
+    out/
+
+    # Fleet
+    .fleet
+
+    # Simulation GUI and other tools window save file
+    networktables.json
+    simgui.json
+    *-window.json
+
+    # Simulation data log directory
+    logs/
+
+    # Folder that has CTRE Phoenix Sim device config storage
+    ctre_sim/
+
+    # clangd
+    /.cache
+    compile_commands.json
+
+    # Eclipse generated file for annotation processors
+    .factorypath
+
+    # Byte-compiled / optimized / DLL files
+    __pycache__/
+    *.py[cod]
+    *$py.class
+
+    # Distribution / packaging
+    .Python
+    build/
+    develop-eggs/
+    dist/
+    downloads/
+    eggs/
+    .eggs/
+    lib/
+    lib64/
+    parts/
+    sdist/
+    var/
+    wheels/
+    share/python-wheels/
+    *.egg-info/
+    .installed.cfg
+    *.egg
+    MANIFEST
+
+    # PyInstaller
+    #  Usually these files are written by a python script from a template
+    #  before PyInstaller builds the exe, so as to inject date/other infos into it.
+    *.manifest
+    *.spec
+
+    # Installer logs
+    pip-log.txt
+    pip-delete-this-directory.txt
+
+    # Unit test / coverage reports
+    htmlcov/
+    .tox/
+    .nox/
+    .coverage
+    .coverage.*
+    .cache
+    nosetests.xml
+    coverage.xml
+    *.cover
+    *.py,cover
+    .hypothesis/
+    .pytest_cache/
+    cover/
+
+    # Translations
+    *.mo
+    *.pot
+
+    # Django stuff:
+    local_settings.py
+    db.sqlite3
+    db.sqlite3-journal
+
+    # Flask stuff:
+    instance/
+    .webassets-cache
+
+    # Scrapy stuff:
+    .scrapy
+
+    # Sphinx documentation
+    docs/_build/
+
+    # PyBuilder
+    .pybuilder/
+    target/
+
+    # Jupyter Notebook
+    .ipynb_checkpoints
+
+    # IPython
+    profile_default/
+    ipython_config.py
+
+    # pyenv (Not Enabled by Default)
+    #  .python-version
+
+    # pdm
+    .pdm.toml
+    .pdm-python
+    .pdm-build/
+
+    # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+    __pypackages__/
+
+    # Celery stuff
+    celerybeat-schedule
+    celerybeat.pid
+
+    # SageMath parsed files
+    *.sage.py
+
+    # Environments
+    .env
+    .venv
+    env/
+    venv/
+    ENV/
+    env.bak/
+    venv.bak/
+
+    # Spyder project settings
+    .spyderproject
+    .spyproject
+
+    # Rope project settings
+    .ropeproject
+
+    # mkdocs documentation
+    /site
+
+    # mypy
+    .mypy_cache/
+    .dmypy.json
+    dmypy.json
+
+    # Pyre type checker
+    .pyre/
+
+    # pytype static type analyzer
+    .pytype/
+
+    # Cython debug symbols
+    cython_debug/
+
+    # PyPI configuration file
+    .pypirc
+        """
+    )
+
+    ignore_content += "\n"
+
+    with open(gitignore_path(project_path), "w") as fp:
+        fp.write(ignore_content)
+
+
 def write_default_pyproject(
     project_path: pathlib.Path,
 ):