jjbuchan / docs

0 stars 0 forks source link

Configuring IntelliJ to include copyright header in source files #12

Open jjbuchan opened 3 years ago

jjbuchan commented 3 years ago

In the "Preferences > Editor > Copyright > Copyright Profiles" section of IntelliJ's preferences create a new profile named "Apache 2".

Then in "Copyright text" field, paste the following content:

Copyright $today.year James Buchan

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Up one level, in the "Editor > Copyright" preferences page, choose "Apache 2" as the default project copyright. If it doesn't properly paste the copyright text in the template field, use Command-Shift-V instead and click the "Paste without formatting" button.

You will also need to add a Scope entry for "Project Files" also selecting "Apache 2" as the copyright profile.