Skip to content

Write to gitignore #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lorepozo wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Write to gitignore #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,19 +51,22 @@ $ joe java # outputs .gitignore file for java to stdout
### Overwrite existing `.gitignore` file

```bash
$ joe java > .gitignore # saves a new .gitignore file for java
$ joe java --save # saves a new .gitignore file for java
$ joe java > .gitignore # does the same thing
```

### Append to existing `.gitignore` file

```bash
$ joe java >> .gitignore # appends to an existing .gitignore file
$ joe java --append # appends to an existing .gitignore file
$ joe java >> .gitignore # does the same thing
```

### Multiple languages

```bash
$ joe java node osx > .gitignore # saves a new .gitignore file for multiple languages
$ joe java node osx --save # saves a new .gitignore file for multiple languages
$ joe java node osx > .gitignore # does the same thing
```

### Create and append to a global .gitignore file
Expand All @@ -72,7 +75,8 @@ You can also use joe to append to a global .gitignore. These can be helpful when

```bash
$ git config --global core.excludesfile ~/.gitignore # Optional if you have not yet created a global .gitignore
$ joe OSX SublimeText >> ~/.gitignore
$ joe OSX SublimeText --append -o ~/.gitignore
$ joe OSX SublimeText >> ~/.gitignore # does the same thing as the line above
```

### List all available files
Expand All @@ -90,7 +94,8 @@ Output:
Joe isn't **just** a generator for `.gitignore` files. You can use it and its output wherever a SCM is used.

```bash
$ joe java > .hgignore
$ joe java --save -o .hgignore
$ joe java > .hgignore # does the same thing
```

## Contributing
Expand Down
15 changes: 10 additions & 5 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,21 +64,24 @@ Overwrite existing ``.gitignore`` file

.. code:: bash

$ joe java > .gitignore # saves a new .gitignore file for java
$ joe java --save # saves a new .gitignore file for java
$ joe java > .gitignore # does the same thing

Append to existing ``.gitignore`` file
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. code:: bash

$ joe java >> .gitignore # appends to an existing .gitignore file
$ joe java --append # appends to an existing .gitignore file
$ joe java >> .gitignore # does the same thing

Multiple languages
~~~~~~~~~~~~~~~~~~

.. code:: bash

$ joe java node osx > .gitignore # saves a new .gitignore file for multiple languages
$ joe java node osx --save # saves a new .gitignore file for multiple languages
$ joe java node osx > .gitignore # does the same thing

Create and append to a global .gitignore file
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -90,7 +93,8 @@ otherwise.
.. code:: bash

$ git config --global core.excludesfile ~/.gitignore # Optional if you have not yet created a global .gitignore
$ joe OSX SublimeText >> ~/.gitignore
$ joe OSX SublimeText --append -o ~/.gitignore
$ joe OSX SublimeText >> ~/.gitignore # does the same thing as the line above

List all available files
~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -134,7 +138,8 @@ and its output wherever a SCM is used.

.. code:: bash

$ joe java > .hgignore
$ joe java --save -o .hgignore
$ joe java > .hgignore # does the same thing

Contributing
------------
Expand Down
30 changes: 23 additions & 7 deletions joe/joe.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,20 @@

Usage:
joe (ls | list)
joe [NAME...]
joe (-h | --help)
joe NAME ...
joe NAME ... (-a | --append | -s | --save) [-o FILE]
joe [-h | --help]
joe --version

Arguments:
NAME ... Names of gitignore collections

Options:
-h --help Show this screen.
--version Show version.
-a --append Append to FILE
-h --help Show this screen
-o FILE Output file for appending/saving [default: .gitignore]
-s --save Save to FILE
--version Show version

"""

Expand Down Expand Up @@ -77,8 +84,6 @@ def _handle_gitignores(names):
'\n%s\n'
'Run `joe ls` to see list of available gitignores.\n'
) % "\n".join(failed))
output = []

return output


Expand Down Expand Up @@ -114,7 +119,18 @@ def main():
if arguments['ls'] or arguments['list']:
print(_get_filenames())
elif arguments['NAME']:
print(_handle_gitignores(arguments['NAME']))
output = _handle_gitignores(arguments['NAME'])
mode = None
if arguments['--save']:
mode = 'w'
elif arguments['--append']:
mode = 'a'
if mode:
filepath = arguments['-o']
with open(filepath, mode) as gitignore:
gitignore.write(output)
else:
print(output)
else:
print(__doc__)

Expand Down
2 changes: 1 addition & 1 deletion setup.py
100644 → 100755
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
from setuptools import setup, find_packages


version = '0.0.5'
version = '0.0.6'

setup(
name='joe',
Expand Down