程序文件中添加版权归属

最近在做开源项目,临上线前被告知,需要在每个程序文件追加下版权归属。由于时间紧,我也就放弃了寻找自动化的办法,选择了人工编辑,一番体力操作,花了几分钟时间解决该问题

但为了以后可以高效解决同类问题,还是需要寻找下高效/自动化的办法。因为程序文件动辄百十个,人工编辑麻烦且存在失误可能。

借着节假日研究了下IDE下操作的可行性,发现还真有办法。

以下办法是建立在使用JB公司的IDE,比如WebStorm,Intellij IDEA等。

为多文件统一追加版权归属

如果是想为项目中已经存在的文件统一追加版权说明,可以如下操作解决

  1. 配置Copyright,Editor-Copyright-Copyright Profiles
  1. Copyright配置Scope,Editor-Copyright

    如果要求很简单,所有程序文件同一个Copyright,那么如下配置即可

  1. 应用版权配置到所有文件

    • 资源目录下,选择根文件夹,单击右键,选择Update Copyright...,则IDE即会自动追加版权说明到所有程序文件。

    • IDE默认会自动排除掉非VCS下的文件,比如node_modules,同时非程序文件比如JSON也会自动排除掉

如上操作后,会发现所有程序文件都会追加成功,so easy。

版权更新

有时会出现版权信息需要更新

  1. 如果是只想更新修改的文件,可以在提交时勾选Update Copyright,但这种方式即会自动将修改中的文件版权信息更新
  2. 如果想所有文件更新,只需要在资源目录下选中文件夹,右键Update Copyright即可

多项目共享配置

当前WebStorm等并不支持跨项目共享版权设定,有需求不得不手动在项目间拷贝

针对此已经有人提了相关Issue,感兴趣可以跟踪下

https://youtrack.jetbrains.com/issue/IDEA-243167?_ga=2.243406598.2075586931.1632032900-927496416.1626448071

写在最后

了解这个使用后,以后版权信息问题再也不需要手动批量编辑了。

参考文档