Comments (7)
IMHO, if the user specifies an empty comment-style, then not adding the space seems the right thing to do (even if that changes the behavior for users that have set an empty comment-style).
That alone is a solution for me.
Maybe I'll add the new option to disable adding the space, but then this implies more work (tests), so I am not sure I am going to do that.
from pre-commit-hooks.
Changed --no-space
proposal to --no-space-in-comment-prefix
as requested in #31 and created PR #33 .
from pre-commit-hooks.
Because we always introduce a whitespace character between the comment prefix and the license lines, this is indeed not currently possible: https://github.com/Lucas-C/pre-commit-hooks/blob/master/pre_commit_hooks/insert_license.py#L76
The best you can achieve is this I think:
# #############################################################################
# Copyright (C) 2017 Teela O'Malley
#
# Licensed under the Apache License, Version 2.0 (the "License");
# #############################################################################
import sys
sys.stdout.write("FOO")
With this license file:
#############################################################################
Copyright (C) 2017 Teela O'Malley
Licensed under the Apache License, Version 2.0 (the "License");
#############################################################################
and --comment-style="#"
from pre-commit-hooks.
@Lucas-C Thanks for responding.
This issue is all about the added space.
I find --comment-style ''
somewhat better, because it adds a space at the start, I'ld suggest that an empty comment-style would not add anything to the licence file contents.
from pre-commit-hooks.
Pull Requests are welcome 😊
from pre-commit-hooks.
Good, they not always are ...
So you're good with an empty comment-style resulting in no spaces added?
Maybe I'll throw in an option to disable the addition of the space as well - is --no-space
ok for you as an option?
from pre-commit-hooks.
So you're good with an empty comment-style resulting in no spaces added?
Yes, sounds good.
We just need to check how the tests behave after implementing this: I won't accept a PR that changes this hook behaviour for existing users.
Maybe I'll throw in an option to disable the addition of the space as well - is --no-space ok for you as an option?
Could you clarify if your plan is to change this hook default behaviour, or if you plan to add an extra option for more control over it?
from pre-commit-hooks.
Related Issues (20)
- Ignore empty line in license HOT 2
- insert_license - Only first year range is replaced in existing license HOT 6
- insert_license - Inserting new license with --use-current-year replaces start years in ranges HOT 3
- Matching multiple license headers? HOT 8
- Rename this repo? HOT 3
- insert-license should not add a LF at the end of the license header file if it does not have one, to prevent an ugly empty separator line HOT 2
- Ignore commit amend message files in .git when running forbid-tabs & co by default HOT 7
- CSS (single line comments) set `//` HOT 1
- insert-license detection does not ignore spaces after comment symbols HOT 4
- chmod hook conflicts with shell chmod in a python virtual env HOT 2
- Is there a way of defining a string in the hooks args instead of --license-filepath HOT 2
- How do I specify the hook to be applied to all files in the repo that ends with .py? HOT 2
- breaking changes in 1.5.2 and 1.5.3 - InvalidManifestError HOT 3
- make `forbid-tabs` and `replace-tabs` accept an exclusion list HOT 4
- Feature Request (insert_license): Use multiline comment for python files HOT 1
- Feature Request (insert_license): Dynamic years in license HOT 2
- An error has occurred: InvalidManifestError HOT 3
- pre-commit fails to install/run due to failures within python-Levenshtein-wheels HOT 1
- Error when using `exclude_types`, but not `exclude` HOT 2
- [Enhancement] Update multiple licence year ends in one run. HOT 4
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from pre-commit-hooks.