Error writing report to XML file

[StephenBugden]

Hello,

I posted a question a couple of days ago, but can see that it's now closed:
#46

I changed my code according to the suggestion there, it now reads:
Here's the code:

var gulp = require('gulp');

var CSS_PATH = 'public/css/*/.css';
var DIST_PATH = 'public/dist';

gulp.task('lintcss', function(cb) {
  var fs = require('fs');
  var output = '';

gulp.src(CSS_PATH)
.pipe(csslint())
    .pipe(csslint.reporter('junit-xml', {logger: function(str) { output += str; }}));

  fs.writeFile(DIST_PATH + 'junit.xml', output, cb);
});

But i now get an error 'Error: Invalid reporter'

I took the code original from:
https://www.npmjs.com/package/gulp-csslint
But obviously something still isn't right.

All I really want to do is to output the report as xml to a file.

Best Regards,

Steve

[Ryuno-Ki]

@StephenBugden I'd very grateful if you could use code fences

The following worked for me (albeit being ugly as hell):
http://stackoverflow.com/a/28122171

/*global require*/
var gulp = require('gulp'),
    fs = require('fs'),
    process = require('process'),
    csslint = require('gulp-csslint');

gulp.task('csslint', function(callback) {
    'use strict';
    var file;

    file = 'reports/csslint.xml';

    // Clear old content
    fs.writeFileSync(file, '');

    process.stdout.write = function(chunk) {
        fs.appendFile(file, chunk);
    };

    gulp.src('src/css/*.css')
      .pipe(csslint('./.csslinrc.json'))
      .pipe(csslint.reporter('checkstyle-xml'));
});

You are basically monkeypatching process.stdout.write to behave like you want, since the output variable remains empty after the gulp.pipe finished (albeit it grew by appending strs).

Oh, and your path to file is probably wrong:
DIST_PATH = 'public/dist' + 'junit.xml' = ''public/distjunit.xml'` (missing slash).

[lazd]

@SimenB any thoughts here? Seems like this should be easier than @Ryuno-Ki's solution.

[StephenBugden]

@Ryuno-Ki Thank you for your reply and the tip on the file path.

With some help, I created a custom reporter. I haven't included xml tags but it's trivial to put them in. Here's the code (with code fences as requested :-)

var gulp = require('gulp');
var csslint = require('gulp-csslint');
//path for css files to be validated
var CSS_PATH = 'public/css/**/*.css';

var customReporter = function(file) 
{
  var Msg = "";
  Msg += file.csslint.errorCount + " errors in " + file.path + "\r\n";

  file.csslint.results.forEach(function(result) {
    Msg += result.error.message  + " on line "  + result.error.line + "\r\n";
  });

  require('fs').appendFileSync('cssErrors.txt', Msg); 
};

gulp.task('csslint', function() 
{       
  //Clear the file out if it exists
  require('fs').writeFileSync('cssErrors.txt', '');

  gulp.src(CSS_PATH)
    .pipe(csslint())
    .pipe(csslint.reporter(customReporter));
});

[SimenB]

Try

var gulp = require('gulp');

var CSS_PATH = 'public/css/*/.css';
var DIST_PATH = 'public/dist';

gulp.task('lintcss', cb => {
  var fs = require('fs');
  var output = '';

  gulp.src(CSS_PATH)
    .pipe(csslint())
    .pipe(csslint.reporter('junit-xml', { logger: str => { output += str; } }))
    .on('end', err => {
      if (err) return cb(err);

      fs.writeFile(DIST_PATH + 'junit.xml', output, cb);
    });
});

If it works, the example should be updated.

(difference vs current example is that the current one is synchronous (no on('end'))).

EDIT: Wait, you get invalid reporter? That should only happen if we can't find the reporter (formatter) you want to use...

I don't use either gulp or csslint anymore, do you have a sample project recreating the error that I can test?

[StephenBugden]

@SimenB Thank you for the reply.

I just tried it, completed without errors but no file written out unfortunately.

ps I changed the line to write the file out to have a forward slash before the filename

fs.writeFile(DIST_PATH + '/junit.xml', output, cb);                                         

[SimenB]

Do you have a sample project?

[StephenBugden]

Trying to pull out the relevant bits, as it's all mixed up with a load of other stuff that i was trying.

[SimenB]

you can try just

var path = require('path');

// ...

fs.writeFile(path.join(__dirname, 'dist', 'junit.xml'), output, cb);

To eliminate the path being the problem.

EDIT: Also make sure you're using version 0.3.0 (latest) of this module

[StephenBugden]

Having trouble cutting out the relevant files keep getting an error copying -> file names are longer than supported by the system.

Will try the code in the last reply, thanks.

[StephenBugden]

Modified line to close the directory path i.e.
fs.writeFile(path.join(__dirname, 'dist'), 'junit.xml', output, cb);

Still no file, unfortunately.

[SimenB]

Comma in wrong place

[StephenBugden]

OK thanks, tried:
fs.writeFile(path.join(__dirname, 'public/dist', 'junit.xml'), output, cb);

public/dist is the path relative to the gulpfile.js

[StephenBugden]

Still no file.

[Ryuno-Ki]

Move this:
fs.writeFile(path.join(__dirname, 'dist'), 'junit.xml', output, cb);
to
fs.writeFile(path.join(__dirname, 'dist', 'junit.xml'), output, cb);
(closing bracket in wrong place).

Resp.
fs.writeFile(path.join(__dirname, 'public', 'dist', 'junit.xml'), output, cb);
since path.join cares for OS specific directory separators.

[StephenBugden]

@Ryuno-Ki Thanks, just tried, no difference unfortunately.