error: rename src option to source

I don't like abbreviations. Source looks better properly spelled out.

packages/error/README.md

@@ -26,7 +26,7 @@ Create a pugneum error object.
  - `filename`: the name of the file causing the error
  - `line`: the offending line
  - `column`: the offending column
- - `src`: the pugneum source, if available, for pretty-printing the error context
+ - `source`: the pugneum source, if available, for pretty-printing the error context
 
 The resulting error object is a simple Error object with additional properties given in the arguments.
 
@@ -35,13 +35,13 @@ The resulting error object is a simple Error object with additional properties g
 ```js
 var error = require('pugneum-error');
 
-var err = error('MY_CODE', 'My message', {line: 3, filename: 'myfile', src: 'foo\nbar\nbaz\nbash\nbing'});
+var err = error('MY_CODE', 'My message', {line: 3, filename: 'myfile', source: 'foo\nbar\nbaz\nbash\nbing'});
 // { code: 'PUGNEUM:MY_CODE',
 //   msg: 'My message',
 //   line: 3,
 //   column: undefined,
 //   filename: 'myfile',
-//   src: 'foo\nbar\nbaz\nbash\nbing',
+//   source: 'foo\nbar\nbaz\nbash\nbing',
 //   message: 'myfile:3\n    1| foo\n    2| bar\n  > 3| baz\n    4| bash\n    5| bing\n\nMy message' }
 
 throw err;

packages/error/index.js

@@ -4,7 +4,7 @@ function makeError(code, message, options) {
   var line = options.line;
   var column = options.column;
   var filename = options.filename;
-  var src = options.src;
+  var src = options.source;
   var fullMessage;
   var location = line + (column ? ':' + column : '');
   if (src && line >= 1 && line <= src.split('\n').length) {
@@ -36,7 +36,7 @@ function makeError(code, message, options) {
   err.line = line;
   err.column = column;
   err.filename = filename;
-  err.src = src;
+  err.source = src;
   err.toJSON = function() {
     return {
       code: this.code,

packages/error/test/index.test.js

@@ -8,7 +8,7 @@ describe('with a source', function() {
     var err = error('MY_CODE', 'My message', {
       line: 3,
       filename: 'myfile',
-      src: 'foo\nbar\nbaz\nbash\nbing',
+      source: 'foo\nbar\nbaz\nbash\nbing',
     });
     expect(err.message).toBe(
       'myfile:3\n    1| foo\n    2| bar\n  > 3| baz\n    4| bash\n    5| bing\n\nMy message'
@@ -17,12 +17,12 @@ describe('with a source', function() {
     expect(err.msg).toBe('My message');
     expect(err.line).toBe(3);
     expect(err.filename).toBe('myfile');
-    expect(err.src).toBe('foo\nbar\nbaz\nbash\nbing');
+    expect(err.source).toBe('foo\nbar\nbaz\nbash\nbing');
   });
   test('and no filename', function() {
     var err = error('MY_CODE', 'My message', {
       line: 3,
-      src: 'foo\nbar\nbaz\nbash\nbing',
+      source: 'foo\nbar\nbaz\nbash\nbing',
     });
     expect(err.message).toBe(
       '3\n    1| foo\n    2| bar\n  > 3| baz\n    4| bash\n    5| bing\n\nMy message'
@@ -31,7 +31,7 @@ describe('with a source', function() {
     expect(err.msg).toBe('My message');
     expect(err.line).toBe(3);
     expect(err.filename).toBe(undefined);
-    expect(err.src).toBe('foo\nbar\nbaz\nbash\nbing');
+    expect(err.source).toBe('foo\nbar\nbaz\nbash\nbing');
   });
 });
 
@@ -43,7 +43,7 @@ describe('without source', function() {
     expect(err.msg).toBe('My message');
     expect(err.line).toBe(3);
     expect(err.filename).toBe('myfile');
-    expect(err.src).toBe(undefined);
+    expect(err.source).toBe(undefined);
   });
   test('and with no filename', function() {
     var err = error('MY_CODE', 'My message', {line: 3});
@@ -52,7 +52,7 @@ describe('without source', function() {
     expect(err.msg).toBe('My message');
     expect(err.line).toBe(3);
     expect(err.filename).toBe(undefined);
-    expect(err.src).toBe(undefined);
+    expect(err.source).toBe(undefined);
   });
 });
 
@@ -62,7 +62,7 @@ describe('with column', function() {
       line: 3,
       column: 2,
       filename: 'myfile',
-      src: 'foo\nbar\nbaz\nbash\nbing',
+      source: 'foo\nbar\nbaz\nbash\nbing',
     });
     expect(err.message).toBe(
       'myfile:3:2\n    1| foo\n    2| bar\n  > 3| baz\n--------^\n    4| bash\n    5| bing\n\nMy message'
@@ -71,7 +71,7 @@ describe('with column', function() {
     expect(err.msg).toBe('My message');
     expect(err.line).toBe(3);
     expect(err.filename).toBe('myfile');
-    expect(err.src).toBe('foo\nbar\nbaz\nbash\nbing');
+    expect(err.source).toBe('foo\nbar\nbaz\nbash\nbing');
   });
   test('and with no filename', function() {
     var err = error('MY_CODE', 'My message', {line: 3, column: 1});
@@ -80,7 +80,7 @@ describe('with column', function() {
     expect(err.msg).toBe('My message');
     expect(err.line).toBe(3);
     expect(err.filename).toBe(undefined);
-    expect(err.src).toBe(undefined);
+    expect(err.source).toBe(undefined);
   });
 });
 
@@ -89,7 +89,7 @@ describe('invalid information', function() {
     var err = error('MY_CODE', 'My message', {
       line: 3,
       column: -1,
-      src: 'foo\nbar\nbaz\nbash\nbing',
+      source: 'foo\nbar\nbaz\nbash\nbing',
     });
     expect(err.message).toBe(
       '3:-1\n    1| foo\n    2| bar\n  > 3| baz\n    4| bash\n    5| bing\n\nMy message'
@@ -98,7 +98,7 @@ describe('invalid information', function() {
     expect(err.msg).toBe('My message');
     expect(err.line).toBe(3);
     expect(err.filename).toBe(undefined);
-    expect(err.src).toBe('foo\nbar\nbaz\nbash\nbing');
+    expect(err.source).toBe('foo\nbar\nbaz\nbash\nbing');
   });
   test('out of range line', function() {
     check(0);
@@ -107,14 +107,14 @@ describe('invalid information', function() {
     function check(line) {
       var err = error('MY_CODE', 'My message', {
         line: line,
-        src: 'foo\nbar\nbaz\nbash\nbing',
+        source: 'foo\nbar\nbaz\nbash\nbing',
       });
       expect(err.message).toBe(line + '\n\nMy message');
       expect(err.code).toBe('PUGNEUM:MY_CODE');
       expect(err.msg).toBe('My message');
       expect(err.line).toBe(line);
       expect(err.filename).toBe(undefined);
-      expect(err.src).toBe('foo\nbar\nbaz\nbash\nbing');
+      expect(err.source).toBe('foo\nbar\nbaz\nbash\nbing');
     }
   });
 });

packages/filterer/test/index.test.js

@@ -32,10 +32,7 @@ p
     Filters can be used.
 `;
 
-  const ast = parse(lex(source, {filename}), {
-    filename,
-    src: source,
-  });
+  const ast = parse(lex(source, {filename}), {filename, source});
 
   const output = filter(ast, customFilters);
   expect(output).toMatchSnapshot();
@@ -50,10 +47,7 @@ p
     They're just strings.
 `;
 
-  const ast = parse(lex(source, {filename}), {
-    filename,
-    src: source,
-  });
+  const ast = parse(lex(source, {filename}), {filename, source});
 
   const output = filter(ast, customFilters);
   expect(output).toMatchSnapshot();

packages/filterer/test/per-filter-options-applied-to-nested-filters.test.js

@@ -24,10 +24,7 @@ p
     Will be wrapped in second.
 `;
 
-  const ast = parse(lex(source, {filename}), {
-    filename,
-    src: source,
-  });
+  const ast = parse(lex(source, {filename}), {filename, source});
 
   const options = {
       second: {wrap: true},

packages/filterer/test/resolution.test.js

@@ -7,15 +7,15 @@ const filter = require('../');
 
 test('installed filter packages can be used implicitly', () => {
 
-  const src = `
+  const source = `
 pre
   code
     :'highlight.js'(language=ruby)
       puts 'This should be', :syntax_highlighted
 `;
 
-  const tokens = lex(src, {filename});
-  const ast = parse(tokens, {filename, src});
+  const tokens = lex(source, {filename});
+  const ast = parse(tokens, {filename, source});
   const filtered = filter(ast);
 
   expect(filtered).toMatchSnapshot();

packages/lexer/index.js

@@ -92,7 +92,7 @@ Lexer.prototype = {
       line: this.lineno,
       column: this.colno,
       filename: this.filename,
-      src: this.originalInput,
+      source: this.originalInput,
     });
     throw err;
   },

packages/linker/test/index.test.js

@@ -12,9 +12,9 @@ function testDir(dir) {
     if (!/\.pg$/.test(name)) return;
     test(name, function() {
       let filename = dir + '/' + name;
-      let src = fs.readFileSync(filename, 'utf8');
-      let options = {filename, src, lex, parse, basedir};
-      let tokens = lex(src, options);
+      let source = fs.readFileSync(filename, 'utf8');
+      let options = {filename, source, lex, parse, basedir};
+      let tokens = lex(source, options);
       let ast = parse(tokens, options);
       let loaded = load(ast, options);
       var actual = link(loaded);

packages/loader/index.js

@@ -33,7 +33,7 @@ function load(ast, options) {
         file.str = str;
         file.raw = raw;
         if (node.type === 'Extends' || node.type === 'Include') {
-          let opts = assign({}, options, {filename: path, src: str});
+          let opts = assign({}, options, {filename: path, source: str});
           let tokens = options.lex(str, opts);
           let ast = options.parse(tokens, opts);
           file.ast = load(ast, opts);

packages/parser/README.md

@@ -20,16 +20,16 @@ Convert pugneum tokens into an abstract syntax tree (AST).
 
  - `filename` (string): pugneum file name; included in AST nodes and used in error handling
  - `plugins` (array): array of plugins in the order they should be applied
- - `src` (string): pugneum source code before tokenization; used in error handling
+ - `source` (string): pugneum source code before tokenization; used in error handling
 
 ```js
 const lex = require('pugneum-lexer');
 
 let filename = 'my-file.pg';
-let src = 'div(data-foo="bar")';
-let tokens = lex(src, {filename});
+let source = 'div(data-foo="bar")';
+let tokens = lex(source, {filename});
 
-let ast = parse(tokens, {filename, src});
+let ast = parse(tokens, {filename, source});
 
 console.log(JSON.stringify(ast, null, '  '))
 ```

packages/parser/index.js

@@ -55,7 +55,7 @@ function Parser(tokens, options) {
   }
   this.tokens = new TokenStream(tokens);
   this.filename = options.filename;
-  this.src = options.src;
+  this.source = options.source;
   this.inMixin = 0;
   this.plugins = options.plugins || [];
 }
@@ -76,7 +76,7 @@ Parser.prototype = {
       line: token.loc.start.line,
       column: token.loc.start.column,
       filename: this.filename,
-      src: this.src,
+      source: this.source,
     });
     throw err;
   },

packages/pugneum/index.js

@@ -11,7 +11,7 @@ const render = require('pugneum-renderer');
 
 function renderPugneum(string, options) {
   options ||= {};
-  options.src = string;
+  options.source = string;
   options.lex = lex;
   options.parse = parse;
 
@@ -27,10 +27,10 @@ function renderPugneum(string, options) {
 
 function renderPugneumFile(path, options) {
   path = resolve(path);
-  let src = fs.readFileSync(path, 'utf8');
+  let source = fs.readFileSync(path, 'utf8');
   options ||= {};
   options.filename = path;
-  return renderPugneum(src, options);
+  return renderPugneum(source, options);
 };
 
 exports.render = renderPugneum;