├── test ├── fixtures │ ├── insert-final-newline-false │ │ ├── file │ │ └── .editorconfig │ ├── insert-final-newline-true │ │ ├── file │ │ └── .editorconfig │ ├── trim-trailing-whitespace-true │ │ ├── file │ │ └── .editorconfig │ ├── end-of-line │ │ ├── .editorconfig │ │ └── file │ ├── indent-char-tab │ │ ├── .editorconfig │ │ └── file │ ├── indent-char-null │ │ ├── file │ │ └── .editorconfig │ └── indent-char-space │ │ ├── file │ │ └── .editorconfig ├── mocha.opts ├── end-of-line.coffee ├── trim-trailing-whitespace.coffee ├── insert-final-newline.coffee └── indent-char.coffee ├── .npmignore ├── lib ├── util.coffee ├── editorconfigerror.coffee ├── editorconfig.coffee ├── rules │ ├── end-of-line.coffee │ ├── max-line-length.coffee │ ├── trim-trailing-whitespace.coffee │ ├── insert-final-newline.coffee │ └── indent-char.coffee ├── cli.coffee ├── rule.coffee ├── line-rule.coffee └── index.coffee ├── bin └── index.js ├── .travis.yml ├── .editorconfig ├── .gitignore ├── Makefile ├── package.json ├── README.md └── LICENSE /test/fixtures/insert-final-newline-false/file: -------------------------------------------------------------------------------- 1 | line -------------------------------------------------------------------------------- /test/fixtures/insert-final-newline-true/file: -------------------------------------------------------------------------------- 1 | line 2 | -------------------------------------------------------------------------------- /.npmignore: -------------------------------------------------------------------------------- 1 | test/ 2 | .editorconfig 3 | .travis.yml 4 | src/ 5 | -------------------------------------------------------------------------------- /test/fixtures/trim-trailing-whitespace-true/file: -------------------------------------------------------------------------------- 1 | line 2 | line 3 | -------------------------------------------------------------------------------- /test/fixtures/end-of-line/.editorconfig: -------------------------------------------------------------------------------- 1 | [*] 2 | end_of_line = crlf 3 | -------------------------------------------------------------------------------- /lib/util.coffee: -------------------------------------------------------------------------------- 1 | eolRegex = /\r\n|\n|\r/ 2 | module.exports = {eolRegex} 3 | -------------------------------------------------------------------------------- /test/fixtures/end-of-line/file: -------------------------------------------------------------------------------- 1 | line one 2 | line two 3 | line three 4 | -------------------------------------------------------------------------------- /test/fixtures/indent-char-tab/.editorconfig: -------------------------------------------------------------------------------- 1 | [*] 2 | indent_style = tab 3 | -------------------------------------------------------------------------------- /test/fixtures/indent-char-tab/file: -------------------------------------------------------------------------------- 1 | line one 2 | line two 3 | line three 4 | -------------------------------------------------------------------------------- /test/fixtures/indent-char-null/file: -------------------------------------------------------------------------------- 1 | line one 2 | line two 3 | line three 4 | -------------------------------------------------------------------------------- /test/fixtures/indent-char-space/file: -------------------------------------------------------------------------------- 1 | line one 2 | line two 3 | line three 4 | -------------------------------------------------------------------------------- /test/mocha.opts: -------------------------------------------------------------------------------- 1 | --reporter spec 2 | --compilers coffee:coffee-script/register 3 | -------------------------------------------------------------------------------- /test/fixtures/insert-final-newline-true/.editorconfig: -------------------------------------------------------------------------------- 1 | [*] 2 | insert_final_newline = true 3 | -------------------------------------------------------------------------------- /test/fixtures/indent-char-space/.editorconfig: -------------------------------------------------------------------------------- 1 | [*] 2 | indent_style = space 3 | indent_size = 2 4 | -------------------------------------------------------------------------------- /test/fixtures/insert-final-newline-false/.editorconfig: -------------------------------------------------------------------------------- 1 | [*] 2 | insert_final_newline = false 3 | -------------------------------------------------------------------------------- /bin/index.js: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env node 2 | require('coffee-script/register'); 3 | require('../lib/cli'); 4 | -------------------------------------------------------------------------------- /test/fixtures/indent-char-null/.editorconfig: -------------------------------------------------------------------------------- 1 | [*] 2 | indent_style = null 3 | indent_size = null 4 | -------------------------------------------------------------------------------- /test/fixtures/trim-trailing-whitespace-true/.editorconfig: -------------------------------------------------------------------------------- 1 | [*] 2 | trim_trailing_whitespace = true 3 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: node_js 2 | node_js: 3 | - "0.10" 4 | - "0.8" 5 | 6 | before_install: 7 | - npm install -g npm@~1.4.6 8 | -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | # This file is for unifying the coding style for different editors and IDEs 2 | # editorconfig.org 3 | 4 | root = true 5 | 6 | [*] 7 | end_of_line = lf 8 | charset = utf-8 9 | insert_final_newline = true 10 | trim_trailing_whitespace = true 11 | indent_style = space 12 | indent_size = 2 13 | max_line_length = 80 14 | 15 | [*.{md,json}] 16 | max_line_length = null 17 | 18 | [Makefile] 19 | indent_style = tab 20 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | 5 | # Runtime data 6 | pids 7 | *.pid 8 | *.seed 9 | 10 | # Directory for instrumented libs generated by jscoverage/JSCover 11 | lib-cov 12 | 13 | # Coverage directory used by tools like istanbul 14 | coverage 15 | 16 | # Compiled binary addons (http://nodejs.org/api/addons.html) 17 | build/Release 18 | 19 | # Dependency directory 20 | node_modules 21 | 22 | # made by the Makefile when building the CoffeeScript 23 | src 24 | 25 | .DS_Store 26 | -------------------------------------------------------------------------------- /lib/editorconfigerror.coffee: -------------------------------------------------------------------------------- 1 | ###* 2 | * The default SyntaxError class doesn't accept fileName or lineNumber args. 3 | * Also, being able to pass in the context (text that threw the error) is nice. 4 | ### 5 | class EditorConfigError extends Error 6 | constructor: (@message, @fileName, @lineNumber, @context) -> 7 | 8 | toString: => 9 | text = @fileName 10 | if @lineNumber? 11 | text += ":#{@lineNumber}" 12 | if @context? 13 | text += "\n#{context}" 14 | text += "\nEditorConfigError: #{@message}" 15 | 16 | module.exports = EditorConfigError 17 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | .PHONY: build unbuild 2 | 3 | define DEVELOPMENT_BIN 4 | #!/usr/bin/env node 5 | require('coffee-script/register'); 6 | require('../lib/cli'); 7 | endef 8 | export DEVELOPMENT_BIN 9 | 10 | define PRODUCTION_BIN 11 | #!/usr/bin/env node 12 | require('../lib/cli'); 13 | endef 14 | export PRODUCTION_BIN 15 | 16 | build: 17 | cp -R lib src 18 | ./node_modules/.bin/coffee --bare --compile lib 19 | find lib -iname "*.coffee" -exec rm '{}' ';' 20 | echo "$$PRODUCTION_BIN" > ./bin/index.js 21 | 22 | unbuild: 23 | rm -rf lib 24 | mv src lib 25 | echo "$$DEVELOPMENT_BIN" > ./bin/index.js 26 | -------------------------------------------------------------------------------- /lib/editorconfig.coffee: -------------------------------------------------------------------------------- 1 | editorconfig = require('editorconfig').parse 2 | 3 | ###* 4 | * Wrapper for the editorconfig function - converts `indent_style` and 5 | `indent_size` into `indent_char` 6 | ### 7 | module.exports = (filepath) -> 8 | editorconfig(filepath).then((properties) -> 9 | properties['indent_char'] = ( 10 | if 'tab' in [properties['indent_size'], properties['indent_style']] 11 | '\t' 12 | else if not isNaN(properties['indent_size']) 13 | Array(properties['indent_size'] + 1).join(' ') 14 | else if properties['indent_style'] is 'space' 15 | ' ' # 2 spaces is pretty common 16 | else 17 | undefined 18 | ) 19 | delete properties['indent_style'] 20 | delete properties['indent_size'] 21 | return properties 22 | ) 23 | -------------------------------------------------------------------------------- /lib/rules/end-of-line.coffee: -------------------------------------------------------------------------------- 1 | LineRule = require '../line-rule' 2 | {eolRegex} = require '../util' 3 | 4 | class EndOfLine extends LineRule 5 | propertyName: 'end_of_line' 6 | 7 | fixLine: (line) => 8 | line.replace(eolRegex, (match) => 9 | switch @setting 10 | when 'crlf' 11 | '\r\n' 12 | when 'cr' 13 | '\r' 14 | when 'lf' 15 | '\n' 16 | else 17 | throw new Error("unsupported value for end_of_line: #{@setting}") 18 | ) 19 | 20 | ###* 21 | * Infer the line ending, returning `undefined` if there is no line ending 22 | * @param {String} line 23 | ### 24 | inferLine: (line) -> 25 | switch line.match(eolRegex)?[0] 26 | when '\r\n' 27 | 'crlf' 28 | when '\n' 29 | 'lf' 30 | when '\r' 31 | 'cr' 32 | 33 | module.exports = EndOfLine 34 | -------------------------------------------------------------------------------- /lib/rules/max-line-length.coffee: -------------------------------------------------------------------------------- 1 | LineRule = require '../line-rule' 2 | W = require 'when' 3 | 4 | EditorConfigError = require '../editorconfigerror' 5 | 6 | ###* 7 | * @todo Implement fixing and inferring properly. It sucks right now. 8 | ### 9 | class MaxLineLength extends LineRule 10 | propertyName: 'max_line_length' 11 | 12 | ###* 13 | * Lifted from end_of_line.coffee 14 | ### 15 | _eolRegex: /(?:\r\n|\n|\r)?$/ 16 | 17 | infer: -> 18 | deferred = W.defer() 19 | deferred.resolve(80) # most code-bases use that :P 20 | return deferred.promise 21 | 22 | checkLine: (line, lineNum) => 23 | lineLength = @inferLine(line) 24 | if lineLength > @setting 25 | throw new EditorConfigError( 26 | "line is #{lineLength} chars, it should be #{@setting}" 27 | @file.path 28 | lineNum 29 | ) 30 | 31 | inferLine: (line) => 32 | # the line ending doesn't count. subtract it 33 | line.length - line.match(@_eolRegex)?[0].length 34 | 35 | module.exports = MaxLineLength 36 | -------------------------------------------------------------------------------- /lib/rules/trim-trailing-whitespace.coffee: -------------------------------------------------------------------------------- 1 | LineRule = require '../line-rule' 2 | 3 | class TrimTrailingWhitespace extends LineRule 4 | propertyName: 'trim_trailing_whitespace' 5 | 6 | ###* 7 | * The first group is any trailing whitespace, and the 2nd group is the line 8 | ending (which might not be there if `insert_final_newline` is false). 9 | * @type {Regex} 10 | ### 11 | _trailingWhitespace: /[^\S\r\n]+(\r\n|\n|\r|)$/ 12 | fixLine: (line) => 13 | if @setting 14 | match = line.match(@_trailingWhitespace) 15 | # join the line (without trailing space), with the captured line ending 16 | # (if there is one) 17 | if match? 18 | return line[...-(match[0].length)] + match[1] 19 | return line 20 | 21 | infer: => 22 | @fileAsLines().then((lines) => 23 | for line in lines 24 | # if any lines have trailing whitespace, it's not being trimmed 25 | if not @inferLine(line) then return false 26 | return true 27 | ) 28 | 29 | inferLine: (line) => 30 | not @_trailingWhitespace.test(line) 31 | 32 | module.exports = TrimTrailingWhitespace 33 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "editorconfig-tools", 3 | "description": "Tools for verifying/fixing code style based on an EditorConfig file", 4 | "version": "0.1.1", 5 | "author": "Sean Lang ", 6 | "bin": { 7 | "editorconfig-tools": "bin/index.js" 8 | }, 9 | "bugs": { 10 | "url": "https://github.com/slang800/editorconfig-tools/issues" 11 | }, 12 | "dependencies": { 13 | "argparse": "^1.0.7", 14 | "detect-indent": "^4.0.0", 15 | "editorconfig": "^0.13.2", 16 | "fobject": "0.0.4", 17 | "graceful-fs": "^4.1.5", 18 | "lodash": "^4.14.0", 19 | "require-tree": "^1.1.1", 20 | "when": "^3.1.0" 21 | }, 22 | "devDependencies": { 23 | "coffee-script": "^1.10.0", 24 | "mocha": "^2.0.1", 25 | "should": "^10.0.0" 26 | }, 27 | "keywords": [ 28 | "code-quality", 29 | "editorconfig", 30 | "enforce", 31 | "fix", 32 | "formatting", 33 | "infer", 34 | "tools", 35 | "validate" 36 | ], 37 | "license": "GPL-3.0", 38 | "main": "lib", 39 | "repository": { 40 | "type": "git", 41 | "url": "git://github.com/slang800/editorconfig-tools.git" 42 | }, 43 | "scripts": { 44 | "test": "mocha" 45 | } 46 | } 47 | -------------------------------------------------------------------------------- /lib/rules/insert-final-newline.coffee: -------------------------------------------------------------------------------- 1 | Rule = require '../rule' 2 | W = require 'when' 3 | 4 | class InsertFinalNewline extends Rule 5 | propertyName: 'insert_final_newline' 6 | 7 | ###* 8 | * @type {Regex} 9 | * @private 10 | ### 11 | _finalNewline: /(?:\r\n|\n|\r)?$/ 12 | 13 | fix: => 14 | super().then( => 15 | @file.read(encoding:'utf8') 16 | ).then((data) => 17 | # don't add a newline to empty files 18 | if data is '' then return W.resolve() 19 | 20 | @file.write(data.replace(@_finalNewline, (match) => 21 | if @setting is false 22 | '' 23 | else 24 | # choose the correct type of newline to insert 25 | switch @editorconfig['end_of_line'] 26 | when 'crlf' 27 | '\r\n' 28 | when 'cr' 29 | '\r' 30 | else # 'lf' or undefined 31 | '\n' 32 | )) 33 | ) 34 | 35 | infer: => 36 | @file.read(encoding: 'utf8').then((data) => 37 | if data is '' then return true # empty files don't need final newlines 38 | finalNewline = data.match(@_finalNewline) 39 | return (finalNewline? and finalNewline[0] isnt '') 40 | ) 41 | 42 | module.exports = InsertFinalNewline 43 | -------------------------------------------------------------------------------- /lib/rules/indent-char.coffee: -------------------------------------------------------------------------------- 1 | LineRule = require '../line-rule' 2 | Rule = require '../rule' 3 | detectIndent = require 'detect-indent' 4 | 5 | EditorConfigError = require '../editorconfigerror' 6 | 7 | class IndentChar extends LineRule 8 | ###* 9 | * This actually isn't an official property. It's a combination of the 10 | `indent_style` and `indent_size` properties that's used internally to do 11 | them both at once. 12 | ### 13 | propertyName: 'indent_char' 14 | 15 | fix: => 16 | @infer().then((@_detectedSetting) => 17 | if not @_detectedSetting? 18 | throw new Error('couldn\'t detect indentation') 19 | if @setting is @_detectedSetting then return 20 | @_indentRegex = new RegExp("^(?:#{@_detectedSetting})*") 21 | super() # loop through all the lines, fixing indentation 22 | ) 23 | 24 | fixLine: (line) => 25 | match = line.match(@_indentRegex)[0] 26 | totalIndents = match.length / @_detectedSetting.length 27 | Array(totalIndents + 1).join(@setting) + line[match.length..] 28 | 29 | check: Rule::check 30 | 31 | infer: => 32 | @file.read(encoding: 'utf8').then(detectIndent).then((res) -> 33 | if res.type is null 34 | null 35 | else 36 | res.indent 37 | ) 38 | 39 | module.exports = IndentChar 40 | -------------------------------------------------------------------------------- /lib/cli.coffee: -------------------------------------------------------------------------------- 1 | path = require 'path' 2 | packageInfo = require(path.join(__dirname, '../package.json')) 3 | ArgumentParser = require('argparse').ArgumentParser 4 | {check, fix, infer} = require './index' 5 | 6 | argparser = new ArgumentParser( 7 | version: packageInfo.version 8 | addHelp: true 9 | description: packageInfo.description 10 | ) 11 | subparsers = argparser.addSubparsers( 12 | title: 'action' 13 | dest: 'action' 14 | ) 15 | inferCommand = subparsers.addParser( 16 | 'infer' 17 | help: 'Infer .editorconfig settings from one or more files' 18 | addHelp: true 19 | ) 20 | inferCommand.addArgument( 21 | ['files'] 22 | type: 'string' 23 | metavar: 'FILE' 24 | nargs: '+' 25 | help: 'The file(s) to use' 26 | ) 27 | 28 | checkCommand = subparsers.addParser( 29 | 'check' 30 | help: 'Validate that file(s) adhere to .editorconfig settings, returning an 31 | error code if they don\'t' 32 | addHelp: true 33 | ) 34 | checkCommand.addArgument( 35 | ['files'] 36 | type: 'string' 37 | metavar: 'FILE' 38 | nargs: '+' 39 | help: 'The file(s) to use' 40 | ) 41 | 42 | fixCommand = subparsers.addParser( 43 | 'fix' 44 | help: 'Fix formatting errors that disobey .editorconfig settings' 45 | addHelp: true 46 | ) 47 | fixCommand.addArgument( 48 | ['files'] 49 | type: 'string' 50 | metavar: 'FILE' 51 | nargs: '+' 52 | help: 'The file(s) to use' 53 | ) 54 | 55 | argv = argparser.parseArgs() 56 | 57 | if argv.action is 'check' 58 | check(argv.files) 59 | else if argv.action is 'fix' 60 | fix(argv.files) 61 | else if argv.action is 'infer' 62 | infer(argv.files) 63 | -------------------------------------------------------------------------------- /lib/rule.coffee: -------------------------------------------------------------------------------- 1 | path = require 'path' 2 | File = require 'fobject' 3 | W = require 'when' 4 | 5 | EditorConfigError = require './editorconfigerror' 6 | editorconfig = require './editorconfig' 7 | 8 | class Rule 9 | ###* 10 | * The "official" name of the rule, according to the editorconfig spec. 11 | * @type {String} 12 | ### 13 | propertyName: '' 14 | 15 | ###* 16 | * The setting of the rule for the file being tested. 17 | * @type {String|Integer|Boolean} 18 | ### 19 | setting: undefined 20 | 21 | ###* 22 | * The file being tested. 23 | * @type {File} 24 | ### 25 | file: undefined 26 | 27 | ###* 28 | * Setup the Rule for a given filename so the other methods can be used. 29 | * @param {String} filename 30 | ### 31 | constructor: (filename) -> 32 | return editorconfig(filename).then((@editorconfig) => 33 | @setting = @editorconfig[@propertyName] 34 | @file = new File(filename) 35 | return this 36 | ) 37 | 38 | ###* 39 | * Fix the file so it matches the given editorconfig setting 40 | * @return {Promise} 41 | ### 42 | fix: => 43 | if not @setting? 44 | W.reject(new EditorConfigError( 45 | "cannot fix #{@propertyName} (no setting defined)" 46 | )) 47 | else 48 | W() 49 | 50 | ###* 51 | * Ensure that the file obeys the editorconfig setting. Throw an error if it 52 | doesn't. 53 | * @return {Promise} 54 | ### 55 | check: => 56 | if not @setting? 57 | W.resolve(null) # the setting isn't defined, so we can't check it 58 | else 59 | @infer().then((detectedSetting) => 60 | if detectedSetting? and detectedSetting isnt @setting 61 | throw new EditorConfigError( 62 | "found setting '#{detectedSetting}', should be '#{@setting}'" 63 | @file.path 64 | ) 65 | ) 66 | 67 | ###* 68 | * Determine the value of the setting based on the contents of the file. 69 | * @return {Promise} A promise for the value of the setting. 70 | ### 71 | infer: -> 72 | 73 | module.exports = Rule 74 | -------------------------------------------------------------------------------- /test/end-of-line.coffee: -------------------------------------------------------------------------------- 1 | require 'should' 2 | File = require 'fobject' 3 | 4 | EndOfLine = require '../lib/rules/end-of-line' 5 | 6 | describe 'end_of_line rule unit', -> 7 | before -> 8 | (new EndOfLine('fakefile')).then((rule) => 9 | @rule = rule 10 | ) 11 | 12 | it 'should have the correct propertyName', -> 13 | @rule.propertyName.should.eql('end_of_line') 14 | 15 | it 'should detect line endings correctly', -> 16 | @rule.inferLine('\n').should.eql('lf') 17 | @rule.inferLine('text\n').should.eql('lf') 18 | @rule.inferLine('text\r\n').should.eql('crlf') 19 | @rule.inferLine('text\r').should.eql('cr') 20 | (@rule.inferLine('text')?).should.eql(false) 21 | 22 | it 'should fix line endings', -> 23 | @rule.fixLine('\n').should.eql('\n') 24 | @rule.fixLine('text\n').should.eql('text\n') 25 | @rule.fixLine('text\r\n').should.eql('text\n') 26 | @rule.fixLine('text\r').should.eql('text\n') 27 | @rule.fixLine('text').should.eql('text') 28 | 29 | describe 'end_of_line rule integration tests', -> 30 | before -> 31 | @file = new File('./test/fixtures/end-of-line/file') 32 | (new EndOfLine('./test/fixtures/end-of-line/file')).then((rule) => 33 | @rule = rule 34 | ) 35 | 36 | after -> 37 | # reset file state 38 | @file.write( 39 | 'line one\r\nline two\r\nline three\r\n' 40 | ) 41 | 42 | it 'should detect lf line endings', -> 43 | @file.write( 44 | 'line one\nline two\nline three\n' 45 | ).then( 46 | @rule.infer 47 | ).then((res) -> 48 | res.should.eql('lf') 49 | ) 50 | 51 | it 'should detect crlf line endings', -> 52 | @file.write( 53 | 'line one\r\nline two\r\nline three\r\n' 54 | ).then( 55 | @rule.infer 56 | ).then((res) -> 57 | res.should.eql('crlf') 58 | ) 59 | 60 | it 'should fix lf line endings', -> 61 | @file.write( 62 | 'line one\nline two\nline three\n' 63 | ).then( 64 | @rule.fix 65 | ).then( => 66 | @file.read(encoding: 'utf8') 67 | ).then((res) -> 68 | res.should.eql('line one\r\nline two\r\nline three\r\n') 69 | ) 70 | 71 | it 'should fix mixed line endings', -> 72 | @file.write( 73 | 'line one\nline two\r\nline three\r' 74 | ).then( 75 | @rule.fix 76 | ).then( => 77 | @file.read(encoding: 'utf8') 78 | ).then((res) -> 79 | res.should.eql('line one\r\nline two\r\nline three\r\n') 80 | ) 81 | 82 | it 'should fix line endings without adding a trailing line', -> 83 | @file.write( 84 | 'line one\nline two\nline three' 85 | ).then( 86 | @rule.fix 87 | ).then( => 88 | @file.read(encoding: 'utf8') 89 | ).then((res) -> 90 | res.should.eql('line one\r\nline two\r\nline three') 91 | ) 92 | -------------------------------------------------------------------------------- /test/trim-trailing-whitespace.coffee: -------------------------------------------------------------------------------- 1 | require 'should' 2 | File = require 'fobject' 3 | 4 | InsertFinalNewline = require '../lib/rules/trim-trailing-whitespace' 5 | 6 | describe 'trim_trailing_whitespace rule unit', -> 7 | before -> 8 | (new InsertFinalNewline('fakefile')).then((rule) => 9 | @rule = rule 10 | ) 11 | 12 | it 'should have the correct propertyName', -> 13 | @rule.propertyName.should.eql('trim_trailing_whitespace') 14 | 15 | it 'should detect trailing whitespace', -> 16 | @rule.inferLine('line \n').should.eql(false) 17 | @rule.inferLine('line\t\n').should.eql(false) 18 | @rule.inferLine('line \t\n').should.eql(false) 19 | @rule.inferLine('line \t').should.eql(false) 20 | @rule.inferLine('line\n').should.eql(true) 21 | @rule.inferLine('line').should.eql(true) 22 | @rule.inferLine('').should.eql(true) 23 | 24 | it 'should fix trailing whitespace', -> 25 | @rule.fixLine('line \n').should.eql('line\n') 26 | @rule.fixLine('line\t\n').should.eql('line\n') 27 | @rule.fixLine('line \t\n').should.eql('line\n') 28 | @rule.fixLine('line\n').should.eql('line\n') 29 | @rule.fixLine('line').should.eql('line') 30 | @rule.fixLine('').should.eql('') 31 | 32 | describe 'trim_trailing_whitespace rule integration (true)', -> 33 | before -> 34 | @file = new File('./test/fixtures/trim-trailing-whitespace-true/file') 35 | @file.write( 36 | 'line\n' 37 | ).then( -> 38 | new InsertFinalNewline( 39 | './test/fixtures/trim-trailing-whitespace-true/file' 40 | ) 41 | ).then((rule) => 42 | @rule = rule 43 | ) 44 | 45 | after -> 46 | # reset file state 47 | @file.write( 48 | 'line\nline\n' 49 | ) 50 | 51 | it 'should detect trailing whitespace', -> 52 | @file.write( 53 | 'line \nline\t\n' 54 | ).then( 55 | @rule.infer 56 | ).then((res) -> 57 | res.should.eql(false) 58 | ) 59 | 60 | it 'should detect mixed trailing whitespace', -> 61 | @file.write( 62 | 'line \nline\n' 63 | ).then( 64 | @rule.infer 65 | ).then((res) -> 66 | res.should.eql(false) 67 | ) 68 | 69 | it 'should detect lack of trailing whitespace', -> 70 | @file.write( 71 | 'line\nline' 72 | ).then( 73 | @rule.infer 74 | ).then((res) -> 75 | res.should.eql(true) 76 | ) 77 | 78 | it 'should fix trailing whitespace', -> 79 | @file.write( 80 | 'line one \nline two\n ' 81 | ).then( 82 | @rule.fix 83 | ).then( => 84 | @file.read(encoding: 'utf8') 85 | ).then((res) -> 86 | res.should.eql('line one\nline two\n') 87 | ) 88 | 89 | it 'should fix trailing whitespace when there is none', -> 90 | @file.write( 91 | 'line one\nline two\n' 92 | ).then( 93 | @rule.fix 94 | ).then( => 95 | @file.read(encoding: 'utf8') 96 | ).then((res) -> 97 | res.should.eql('line one\nline two\n') 98 | ) 99 | -------------------------------------------------------------------------------- /lib/line-rule.coffee: -------------------------------------------------------------------------------- 1 | W = require 'when' 2 | 3 | Rule = require './rule' 4 | EditorConfigError = require './editorconfigerror' 5 | 6 | class LineRule extends Rule 7 | ###* 8 | * Get the contents of the file as an array of lines. 9 | * @return {Promise} A promise for the lines as an array of strings. 10 | ### 11 | fileAsLines: => 12 | @file.read(encoding: 'utf8').then((data) -> 13 | lines = data.split(/(\r\n|\n|\r)/) 14 | # right now the capturing group from the regex is every other element in 15 | # `lines`. Those groups need to be joined with the line before them. 16 | i = 0 17 | joinedLines = [] 18 | while i < lines.length 19 | joinedLines.push lines[i] + (lines[i + 1] or '') 20 | i += 2 21 | if joinedLines[-1..][0] is '' 22 | # split leaves an empty string as the last element in the array if 23 | # the file ends with a linebreak (as it should). remove that. 24 | joinedLines = joinedLines[...-1] 25 | return joinedLines 26 | ) 27 | 28 | fix: => 29 | super().then(@fileAsLines).then((lines) => 30 | newLines = [] 31 | newLines.push(@fixLine line) for line in lines 32 | @file.write(newLines.join('')) 33 | ) 34 | 35 | check: => 36 | if not @setting? 37 | W.resolve(null) # the setting isn't defined, so we can't check it 38 | else 39 | @fileAsLines().then((lines) => 40 | for line, lineNum in lines 41 | @checkLine line, lineNum 42 | ) 43 | 44 | infer: => 45 | @fileAsLines().then((lines) => 46 | lineSettings = [] # list of all settings found in the file 47 | for line in lines 48 | lineSetting = @inferLine line 49 | if lineSetting? and lineSetting not in lineSettings 50 | # keep the array elements unique 51 | lineSettings.push lineSetting 52 | if lineSettings.length is 1 53 | return lineSettings[0] 54 | else 55 | throw new Error( 56 | "multiple setting values found: #{lineSettings.join(', ')}" 57 | ) 58 | ) 59 | 60 | ###* 61 | * @param {String} line 62 | * @return {String} The fixed line. 63 | ### 64 | fixLine: (line) => 65 | throw new Error("Unable to fix #{@propertyName}") 66 | 67 | ###* 68 | * Check if the line is valid according to the rule. By default it just uses 69 | `inferLine` to check aginst the setting for the rule. Throw an exception if 70 | it isn't valid 71 | * @param {String} line 72 | * @param {Integer} lineNum 73 | ### 74 | checkLine: (line, lineNum) => 75 | detectedSetting = @inferLine(line) 76 | if detectedSetting? and detectedSetting isnt @setting 77 | throw new EditorConfigError( 78 | "found setting '#{detectedSetting}', should be '#{@setting}'" 79 | @file.path 80 | lineNum 81 | ) 82 | 83 | ###* 84 | * @param {String} line 85 | * @return {String|Integer|Boolean} Setting value for the line. 86 | ### 87 | inferLine: (line) => 88 | throw new Error("Cannot infer #{@propertyName}") 89 | 90 | module.exports = LineRule 91 | -------------------------------------------------------------------------------- /test/insert-final-newline.coffee: -------------------------------------------------------------------------------- 1 | require 'should' 2 | File = require 'fobject' 3 | 4 | InsertFinalNewline = require '../lib/rules/insert-final-newline' 5 | 6 | describe 'insert_final_newline rule unit', -> 7 | before -> 8 | @rule = new InsertFinalNewline('fakefile') 9 | (new InsertFinalNewline('fakefile')).then((rule) => 10 | @rule = rule 11 | ) 12 | 13 | it 'should have the correct propertyName', -> 14 | @rule.propertyName.should.eql('insert_final_newline') 15 | 16 | describe 'insert_final_newline rule integration (true)', -> 17 | before -> 18 | @file = new File('./test/fixtures/insert-final-newline-true/file') 19 | @file.write( 20 | 'line\n' 21 | ).then( -> 22 | new InsertFinalNewline('./test/fixtures/insert-final-newline-true/file') 23 | ).then((rule) => 24 | @rule = rule 25 | ) 26 | 27 | after -> 28 | # reset file state 29 | @file.write( 30 | 'line\n' 31 | ) 32 | 33 | it 'should detect line ending', -> 34 | @file.write( 35 | 'line\n' 36 | ).then( 37 | @rule.infer 38 | ).then((res) -> 39 | res.should.eql(true) 40 | ) 41 | 42 | it 'shouldn\'t add a newline to empty files', -> 43 | @file.write( 44 | '' 45 | ).then( 46 | @rule.fix 47 | ).then( => 48 | @file.read(encoding: 'utf8') 49 | ).then((res) -> 50 | res.should.eql('') 51 | ) 52 | 53 | it 'should fix missing line ending', -> 54 | @file.write( 55 | 'line' 56 | ).then( 57 | @rule.fix 58 | ).then( => 59 | @file.read(encoding: 'utf8') 60 | ).then((res) -> 61 | res.should.eql('line\n') 62 | ) 63 | 64 | it 'should fix present line ending', -> 65 | @file.write( 66 | 'line\n' 67 | ).then( 68 | @rule.fix 69 | ).then( => 70 | @file.read(encoding: 'utf8') 71 | ).then((res) -> 72 | res.should.eql('line\n') 73 | ) 74 | 75 | describe 'insert_final_newline rule integration (false)', -> 76 | before -> 77 | @file = new File('./test/fixtures/insert-final-newline-false/file') 78 | ( 79 | new InsertFinalNewline('./test/fixtures/insert-final-newline-false/file') 80 | ).then((rule) => 81 | @rule = rule 82 | ) 83 | 84 | after -> 85 | # reset file state 86 | @file.write('line') 87 | 88 | it 'should detect missing line ending', -> 89 | @file.write( 90 | 'line' 91 | ).then( 92 | @rule.infer 93 | ).then((res) -> 94 | res.should.eql(false) 95 | ) 96 | 97 | it 'should fix missing line ending', -> 98 | @file.write( 99 | 'line' 100 | ).then( 101 | @rule.fix 102 | ).then( => 103 | @file.read(encoding: 'utf8') 104 | ).then((res) -> 105 | res.should.eql('line') 106 | ) 107 | 108 | it 'should fix present line ending', -> 109 | @file.write( 110 | 'line\n' 111 | ).then( 112 | @rule.fix 113 | ).then( => 114 | @file.read(encoding: 'utf8') 115 | ).then((res) -> 116 | res.should.eql('line') 117 | ) 118 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # editorconfig-tools 2 | [![Build Status](http://img.shields.io/travis/slang800/editorconfig-tools.svg?style=flat-square)](https://travis-ci.org/slang800/editorconfig-tools) [![NPM version](http://img.shields.io/npm/v/editorconfig-tools.svg?style=flat-square)](https://www.npmjs.org/package/editorconfig-tools) [![NPM license](http://img.shields.io/npm/l/editorconfig-tools.svg?style=flat-square)](https://www.npmjs.org/package/editorconfig-tools) 3 | 4 | This tool-set is for validating or fixing code that doesn't adhere to settings defined in `.editorconfig`. It also is able to infer settings from existing code and generate an `.editorconfig` file that matches all the files that are passed to it. See the [EditorConfig Project](http://editorconfig.org/) for details about the `.editorconfig` file. 5 | 6 | ## CLI 7 | The CLI is (currently) the only way of using editorconfig-tools. The following sections detail the 3 subcommands that editorconfig-tools provides. 8 | 9 | ### infer 10 | Infer `.editorconfig` settings from one or more files and generate an `.editorconfig` file that matches all the files that are passed to it. 11 | 12 | Here's an example using the files from this project. It is assumed that you have [globstar](http://www.linuxjournal.com/content/globstar-new-bash-globbing-option) enabled in your shell. While editorconfig-tools itself doesn't require it, these examples do use it to pass whole directories of files to editorconfig-tools. 13 | 14 | ```bash 15 | $ editorconfig-tools infer ./* ./lib/**/* ./test/**/* 16 | [*] 17 | end_of_line = lf 18 | indent_style = space 19 | indent_size = 2 20 | insert_final_newline = true 21 | max_line_length = 80 22 | trim_trailing_whitespace = true 23 | 24 | [{./test/fixtures/end-of-line/file}] 25 | end_of_line = crlf 26 | 27 | [{./Makefile,./test/fixtures/indent-char-tab/file}] 28 | indent_style: tab 29 | 30 | [{./test/fixtures/insert-final-newline-false/file}] 31 | insert_final_newline = false 32 | ``` 33 | 34 | As you can see, a set of rules has been generated that matches all of the files that we passed in. If we were making an `.editorconfig` file for a project that doesn't already have one, we might want to write this out to a file: 35 | 36 | ```bash 37 | $ editorconfig-tools infer ./* ./lib/**/* ./test/**/* > .editorconfig 38 | ``` 39 | 40 | We would still probably want to add `root = true` to the file (if this is saved at the root of the project), but editorconfig-tools has done most of the work required to make an `.editorconfig` file. 41 | 42 | ### check 43 | Check (validate) that file(s) adhere to `.editorconfig` settings and return a non-zero exit code if errors are encountered (making it suitable for running as a test). For example, if we added some trailing whitespace to our readme, this would be the result: 44 | 45 | ```bash 46 | $ editorconfig-tools check README.md 47 | README.md failed trim_trailing_whitespace on line 46: found setting 'false', should be 'true' 48 | ``` 49 | 50 | ### fix 51 | Fix formatting errors that disobey `.editorconfig` settings. This will modify your files without warning, so you should ensure that your project is under version control before running it. 52 | 53 | For example, if we write a file with 4-space indentation, and then run the fix command (using the settings of this particular project) we will get back a 2-space indented file: 54 | 55 | ```bash 56 | $ echo -e 'line one\n line two' > example-file 57 | $ editorconfig-tools fix ./example-file 58 | $ cat example-file 59 | line one 60 | line two 61 | ``` 62 | 63 | ## Similar Tools 64 | - [eclint](https://github.com/jedmao/eclint) 65 | - [treyhunner/editorconfig-tools](https://github.com/treyhunner/editorconfig-tools) 66 | -------------------------------------------------------------------------------- /test/indent-char.coffee: -------------------------------------------------------------------------------- 1 | require 'should' 2 | File = require 'fobject' 3 | 4 | EditorConfigError = require '../lib/editorconfigerror' 5 | IndentChar = require '../lib/rules/indent-char' 6 | 7 | describe 'indent_style/indent_size rule unit', -> 8 | before -> 9 | (new IndentChar('fakefile')).then((rule) => 10 | @rule = rule 11 | ) 12 | 13 | it 'should have the correct propertyName', -> 14 | @rule.propertyName.should.eql('indent_char') 15 | 16 | describe 'indent_style/indent_size rule integration (spaces)', -> 17 | before -> 18 | @file = new File('./test/fixtures/indent-char-space/file') 19 | (new IndentChar('./test/fixtures/indent-char-space/file')).then((rule) => 20 | @rule = rule 21 | ) 22 | 23 | after -> 24 | # reset file state 25 | @file.write( 26 | 'line one\n line two\n line three\n' 27 | ) 28 | 29 | it 'should detect indentation', -> 30 | @file.write( 31 | 'line one\n line two\n line three\n' 32 | ).then( 33 | @rule.infer 34 | ).then((res) -> 35 | res.should.eql(' ') 36 | ) 37 | 38 | it 'should fix tab indentation', -> 39 | @file.write( 40 | 'line one\n\tline two\n\t\tline three\n' 41 | ).then( 42 | @rule.fix 43 | ).then( => 44 | @file.read(encoding: 'utf8') 45 | ).then((res) -> 46 | res.should.eql('line one\n line two\n line three\n') 47 | ) 48 | 49 | it 'should fix space indentation', -> 50 | @file.write( 51 | 'line one\n line two\n line three\n' 52 | ).then( 53 | @rule.fix 54 | ).then( => 55 | @file.read(encoding: 'utf8') 56 | ).then((res) -> 57 | res.should.eql('line one\n line two\n line three\n') 58 | ) 59 | 60 | describe 'indent_style/indent_size rule integration (tabs)', -> 61 | before -> 62 | @file = new File('./test/fixtures/indent-char-tab/file') 63 | (new IndentChar('./test/fixtures/indent-char-tab/file')).then((rule) => 64 | @rule = rule 65 | ) 66 | 67 | after -> 68 | # reset file state 69 | @file.write( 70 | 'line one\n\tline two\n\t\tline three\n' 71 | ) 72 | 73 | it 'should detect indentation', -> 74 | @file.write( 75 | 'line one\n\tline two\n\t\tline three\n' 76 | ).then( 77 | @rule.infer 78 | ).then((res) -> 79 | res.should.eql('\t') 80 | ) 81 | 82 | it 'should fix tab indentation', -> 83 | @file.write( 84 | 'line one\n\tline two\n\t\tline three\n' 85 | ).then( 86 | @rule.fix 87 | ).then( => 88 | @file.read(encoding: 'utf8') 89 | ).then((res) -> 90 | res.should.eql('line one\n\tline two\n\t\tline three\n') 91 | ) 92 | 93 | it 'should fix space indentation', -> 94 | @file.write( 95 | 'line one\n line two\n line three\n' 96 | ).then( 97 | @rule.fix 98 | ).then( => 99 | @file.read(encoding: 'utf8') 100 | ).then((res) -> 101 | res.should.eql('line one\n\tline two\n\t\tline three\n') 102 | ) 103 | 104 | describe 'indent_style/indent_size rule integration (null)', -> 105 | before -> 106 | @file = new File('./test/fixtures/indent-char-null/file') 107 | (new IndentChar('./test/fixtures/indent-char-null/file')).then((rule) => 108 | @rule = rule 109 | ) 110 | 111 | after -> 112 | # reset file state 113 | @file.write( 114 | 'line one\n line two\n line three\n' 115 | ) 116 | 117 | it 'should throw error and not change the file', -> 118 | @file.write( 119 | 'line one\n line two\n line three\n' 120 | ).then( 121 | @rule.fix 122 | ).catch((e) -> 123 | e.should.eql( 124 | new EditorConfigError('cannot fix indent_char (no setting defined)') 125 | ) 126 | ).then( => 127 | @file.read(encoding: 'utf8') 128 | ).then((res) -> 129 | res.should.eql('line one\n line two\n line three\n') 130 | ) 131 | -------------------------------------------------------------------------------- /lib/index.coffee: -------------------------------------------------------------------------------- 1 | _ = require 'lodash' 2 | W = require 'when' 3 | editorconfig = require 'editorconfig' 4 | fs = require 'graceful-fs' 5 | path = require 'path' 6 | 7 | requireTree = require 'require-tree' 8 | Rules = requireTree './rules' 9 | 10 | check = (files) -> 11 | exitCode = 0 12 | promises = [] 13 | Object.keys(Rules).forEach (ruleName) -> 14 | Rule = Rules[ruleName] 15 | files.forEach (filePath) -> 16 | if fs.lstatSync(filePath).isDirectory() then return 17 | property = undefined 18 | promises.push( 19 | (new Rule(filePath)).then((returnedProperty) -> 20 | property = returnedProperty 21 | property.check() 22 | ).then((res) -> 23 | res: res 24 | file: filePath 25 | rule: property.propertyName 26 | ).catch((err) -> 27 | file: filePath 28 | rule: property.propertyName 29 | error: err 30 | ) 31 | ) 32 | 33 | W.all(promises).done((res) -> 34 | files = _.uniq _.map(res, 'file') 35 | for file in files 36 | matches = _.filter res, file: file 37 | verbose = true 38 | if verbose or _.compact(_.map(matches, 'error')).length > 0 39 | for match in matches 40 | if match.error? 41 | exitCode = 1 42 | text = "#{file} failed #{match.rule}" 43 | if match.error.lineNumber? 44 | text += " on line #{match.error.lineNumber}" 45 | if match.error.message? 46 | text += ": #{match.error.message}" 47 | console.log text 48 | else if verbose 49 | if match.res is null 50 | console.log "#{file} ignored #{match.rule} (no setting defined)" 51 | else 52 | #console.log "#{file} passed #{match.rule}" 53 | process.exit(exitCode) 54 | ) 55 | 56 | fix = (files) -> 57 | results = [] 58 | promise = W.resolve() 59 | for ruleName in Object.keys(Rules) 60 | Rule = Rules[ruleName] 61 | for filePath in files 62 | if fs.lstatSync(filePath).isDirectory() then continue 63 | do (Rule, filePath) -> 64 | property = undefined 65 | promise = promise.then( -> 66 | new Rule(filePath) 67 | ).then((returnedProperty) -> 68 | property = returnedProperty 69 | property.fix() 70 | ).then((res) -> 71 | results.push( 72 | res: res 73 | file: filePath 74 | rule: property.propertyName 75 | ) 76 | ).catch((err) -> 77 | results.push( 78 | file: filePath 79 | rule: property.propertyName 80 | error: err 81 | ) 82 | ) 83 | 84 | promise.done -> 85 | verbose = true 86 | for result in results 87 | if result.error? 88 | console.log "#{result.file} #{result.error.message}" 89 | else if verbose 90 | console.log "#{result.file} fixed" 91 | 92 | infer = (files) -> 93 | promises = [] 94 | Object.keys(Rules).forEach (ruleName) -> 95 | Rule = Rules[ruleName] 96 | files.forEach (filePath) -> 97 | if fs.lstatSync(filePath).isDirectory() then return 98 | property = undefined 99 | promises.push( 100 | (new Rule(filePath)).then((returnedProperty) -> 101 | property = returnedProperty 102 | property.infer() 103 | ).then((res) -> 104 | res: res 105 | file: filePath 106 | rule: property.propertyName 107 | ).catch((err) -> 108 | file: filePath 109 | rule: property.propertyName 110 | error: err 111 | ) 112 | ) 113 | 114 | W.all(promises).done((res) -> 115 | rules = {} 116 | _.remove(res, (e) -> not e.res?) # remove null results 117 | filteredResults = [] 118 | for result in res 119 | if result.rule is 'indent_char' 120 | indentStyle = ( 121 | if result.res is '\t' 122 | 'tab' 123 | else 124 | 'space' 125 | ) 126 | filteredResults.push( 127 | rule: 'indent_style' 128 | res: indentStyle 129 | file: result.file 130 | ) 131 | if indentStyle is 'space' 132 | filteredResults.push( 133 | rule: 'indent_size' 134 | res: String result.res.length 135 | file: result.file 136 | ) 137 | else 138 | # convert result.res to a string because getting distributionOfValues 139 | # involves a step where it is used as an object key, so it becomes a 140 | # string and needs to be matched to. 141 | result.res = String result.res 142 | filteredResults.push(result) 143 | 144 | groups = _.groupBy(filteredResults, 'rule') 145 | for property, group of groups 146 | distributionOfValues = _.toPairs _.countBy _.map(group, 'res'), (x) -> x 147 | sortedValues = _.sortBy distributionOfValues, (x) -> -x[1] 148 | 149 | # most common value gets to be global 150 | rules['[*]'] ?= [] 151 | rules['[*]'].push([property, sortedValues[0][0]]) 152 | 153 | # the rest are given a selector based on what files they hit 154 | for value in sortedValues[1..] 155 | files = _.map _.filter(group, res: value[0]), 'file' 156 | selector = "[{#{files.join(',')}}]" 157 | rules[selector] ?= [] 158 | rules[selector].push([property, value[0]]) 159 | 160 | for selector, ruleGroup of rules 161 | console.log selector 162 | for rule in ruleGroup 163 | console.log "#{rule[0]} = #{rule[1]}" 164 | 165 | console.log '' 166 | ) 167 | 168 | module.exports = {check, fix, infer} 169 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------