feat: add line mode support

Author: cheton

README.md

@@ -80,7 +80,7 @@ parser.parseFile('example.nc', function(err, results) {
 ### batchSize
 
 Type: `Number`
-Default: `1000`
+Default: 1000
 
 The batch size.
 
@@ -99,16 +99,28 @@ parser.parseLine('G0 X0 Y0', { flatten: true });
 // => { line: 'G0 X0 Y0', words: [ 'G0', 'X0', 'Y0' ] }
 ```
 
-### noParseLine
+### lineMode
 
-Type: `Boolean`
-Default: `false`
+Type: `String` 
+Default: `'original'`
+
+The `lineMode` option determines the format of the parsed line. It can be set to one of the following values:
+
+- `'original'`: Returns the original line.
+- `'minimal'`: Returns the line without comments, but retains whitespace characters.
+- `'compact'`: Returns the line without comments and all whitespace characters.
 
-True to not parse line, false otherwise.
+Example usage:
 
 ```js
-parser.parseFile('/path/to/file', { noParseLine: true }, function(err, results) {
-});
+parser.parseLine('G0 X0 Y0 ; comment', { lineMode: 'original' });
+// => { line: 'G0 X0 Y0 ; comment', words: [ [ 'G', 0 ], [ 'X', 0 ], [ 'Y', 0 ] ] }
+
+parser.parseLine('G0 X0 Y0 ; comment', { lineMode: 'minimal' });
+// => { line: 'G0 X0 Y0', words: [ [ 'G', 0 ], [ 'X', 0 ], [ 'Y', 0 ] ] }
+
+parser.parseLine('G0 X0 Y0 ; comment', { lineMode: 'compact' });
+// => { line: 'G0X0Y0', words: [ [ 'G', 0 ], [ 'X', 0 ], [ 'Y', 0 ] ] }
 ```
 
 ## G-code Interpreter

src/__tests__/index.test.js

@@ -43,24 +43,6 @@ describe('Pass an empty text as the first argument', () => {
  });
 });
 
-describe('Contains only lines', () => {
- it('should not parse G-code commands.', (done) => {
- const filepath = path.resolve(__dirname, 'fixtures/circle.gcode');
- parseFile(filepath, { noParseLine: true }, (err, results) => {
- expect(results.length).toBe(7);
- done();
- })
- .on('data', (data) => {
- expect(typeof data).toBe('object');
- expect(typeof data.line).toBe('string');
- expect(data.words).toBe(undefined);
- })
- .on('end', (results) => {
- expect(results.length).toBe(7);
- });
- });
-});
-
 describe('Invalid G-code words', () => {
  it('should ignore invalid g-code words', (done) => {
  const data = parseLine('messed up');

src/index.js

@@ -66,53 +66,61 @@ const parseLine = (() => {
  };
  // http://linuxcnc.org/docs/html/gcode/overview.html#gcode:comments
  // Comments can be embedded in a line using parentheses () or for the remainder of a lineusing a semi-colon. The semi-colon is not treated as the start of a comment when enclosed in parentheses.
- const stripAndExtractComments = (() => {
+ const stripComments = (() => {
  // eslint-disable-next-line no-useless-escape
  const re1 = new RegExp(/\(([^\)]*)\)/g); // Match anything inside parentheses
  const re2 = new RegExp(/;(.*)$/g); // Match anything after a semi-colon to the end of the line
- const re3 = new RegExp(/\s+/g);
 
  return (line) => {
  const comments = [];
  // Extract comments from parentheses
  line = line.replace(re1, (match, p1) => {
- const strippedLine = p1.trim();
- comments.push(strippedLine); // Add the match to comments
+ const lineWithoutComments = p1.trim();
+ comments.push(lineWithoutComments); // Add the match to comments
  return '';
  });
  // Extract comments after a semi-colon
  line = line.replace(re2, (match, p1) => {
- const strippedLine = p1.trim();
- comments.push(strippedLine); // Add the match to comments
+ const lineWithoutComments = p1.trim();
+ comments.push(lineWithoutComments); // Add the match to comments
  return '';
  });
- // Remove whitespace characters
- line = line.replace(re3, '');
+ line = line.trim();
  return [line, comments];
  };
  })();
+
+ const stripWhitespace = (line) => {
+ // Remove whitespace characters
+ const re = new RegExp(/\s+/g);
+ return line.replace(re, '');
+ };
+
  // eslint-disable-next-line no-useless-escape
  const re = /(%.*)|({.*)|((?:\$\$)|(?:\$[a-zA-Z0-9#]*))|([a-zA-Z][0-9\+\-\.]+)|(\*[0-9]+)/igm;
 
  return (line, options) => {
  options = options || {};
  options.flatten = !!options.flatten;
- options.noParseLine = !!options.noParseLine;
+ options.lineMode = options.lineMode ?? 'original'; // One of: 'original', 'minimal', 'compact'
 
  const result = {
- line: line
+ line: line,
+ words: [],
  };
 
- if (options.noParseLine) {
- return result;
- }
-
- result.words = [];
-
  let ln; // Line number
  let cs; // Checksum
- const [strippedLine, comments] = stripAndExtractComments(line);
- const words = strippedLine.match(re) || [];
+ const [minimalLine, comments] = stripComments(line);
+ const compactLine = stripWhitespace(minimalLine);
+
+ if (options.lineMode === 'minimal') {
+ result.line = minimalLine;
+ } else if (options.lineMode === 'compact') {
+ result.line = compactLine;
+ }
+
+ const words = compactLine.match(re) || [];
 
  if (comments.length > 0) {
  result.comments = comments;
@@ -243,7 +251,7 @@ const parseString = (str, options, callback = noop) => {
 };
 
 const parseStringSync = (str, options) => {
- const { flatten = false, noParseLine = false } = { ...options };
+ const { flatten = false } = { ...options };
  const results = [];
  const lines = str.split('\n');
 
@@ -254,7 +262,6 @@ const parseStringSync = (str, options) => {
  }
  const result = parseLine(line, {
  flatten,
- noParseLine
  });
  results.push(result);
  }
@@ -272,7 +279,6 @@ class GCodeLineStream extends Transform {
 
  options = {
  batchSize: 1000,
- noParseLine: false
  };
 
  lineBuffer = '';
@@ -282,7 +288,6 @@ class GCodeLineStream extends Transform {
  // @param {object} [options] The options object
  // @param {number} [options.batchSize] The batch size.
  // @param {boolean} [options.flatten] True to flatten the array, false otherwise.
- // @param {boolean} [options.noParseLine] True to not parse line, false otherwise.
  constructor(options = {}) {
  super({ objectMode: true });
 
@@ -336,7 +341,6 @@ class GCodeLineStream extends Transform {
  if (line.length > 0) {
  const result = parseLine(line, {
  flatten: this.options.flatten,
- noParseLine: this.options.noParseLine
  });
  this.push(result);
  }
@@ -349,7 +353,6 @@ class GCodeLineStream extends Transform {
  if (line.length > 0) {
  const result = parseLine(line, {
  flatten: this.options.flatten,
- noParseLine: this.options.noParseLine
  });
  this.push(result);
  }