Inserts or updates a copyright notice.
The auto-copyright:insert
command adds the configured copyright text with the current year and configured owner text as a comment at the top of the file. The default copyright text looks like this:
## Copyright (c) 2015 by Placeholder Corporation. All Rights Reserved.#
It can be configured to say as much or as little as you want, though.
When you execute the auto-copyright:update
command, it updates the copyright year in a standard format by adding the current year to the list of years and compacting it in the following ways:
2000, 2005, 2010
2001-2003
2001-2003, 2005, 2010
Auto Copyright supports the following configuration settings:
auto-copyright.buffer
— Number of blank commented lines before and after the copyright text. (Defaults to: 1
)auto-copyright.owner
— Owner name to use when creating the copyright text.auto-copyright.template
— Copyright template to follow. %y
will be replaced with the current year. %o
will be replaced with the owner name. (Defaults to: Copyright (c) %y by %o. All Rights Reserved.
)Multi-line templates are supported. At the time of this writing, Atom's Settings View does not support multiline configuration attributes. In order to have a multi-line template, you must manually edit your config.cson
using the CoffeeScript multi-line string format. For example:
'*':'auto-copyright':'template': """Copyright (c) %y by %o. All Rights Reserved.Some standard boilerplate license text."""
auto-copyright:insert
— Inserts the copyright text at the top of the file in the active editorauto-copyright:update
— Updates the year range of the copyright text at the top of the file, if it existsNo keybindings are assigned by default.
Good catch. Let us know what about this package looks wrong to you, and we'll investigate right away.