src/index.js
41 |
const PATTERN = /console\.(log|error|warn|info)/g;
42 |
43 | /**
44 | * Danger plugin to prevent merging code that still has `console.log`s inside it.
45 | */
46 | export default async function noConsole(options = {}) {
47 | const whitelist = options.whitelist || [];
48 | if (!Array.isArray(whitelist)) throw new Error('[danger-plugin-no-console] whitelist option has to be an array.');
49 |
50 | const files = danger.git.modified_files.concat(danger.git.created_files)
51 | const contents = await Promise.all(
52 | files.map(file => danger.github.utils.fileContents(file).then(content => ({
53 | file,
54 | content,
55 | })))
56 | )
57 |
58 | contents.forEach(({ file, content }) => {
59 | let matches = content.match(PATTERN);
60 | if (!matches) return;
61 | matches = matches.filter(match => !whitelist.includes(PATTERN.exec(match)[1]));
62 | if (matches.length === 0) return;
63 |
64 | fail(`${matches.length} console statement(s) left in ${file}.`);
65 | })
66 | }
67 |
68 |
69 |
src/index.test.js
41 |
import noConsole from './';
42 |
43 | const files = {
44 | 'src/log.js': 'function add(a, b) {\n console.log(a, b);\n return a + b;\n}',
45 | 'src/clean.js': 'function add(a, b) {\n return a + b;\n}',
46 | 'src/error.js': 'function add(a, b) {\n console.error(a, b);\n return a + b;\n}',
47 | }
48 |
49 | const fileNames = Object.keys(files);
50 |
51 | // Mock the Danger API
52 | global.danger = {
53 | git: {
54 | modified_files: [fileNames[0], fileNames[1]],
55 | created_files: [fileNames[2]]
56 | },
57 | github: {
58 | utils: {
59 | fileContents: (path) => new Promise(res => {
60 | res(files[path])
61 | })
62 | }
63 | }
64 | }
65 |
66 | beforeEach(() => {
67 | global.fail = jest.fn()
68 | })
69 |
70 | afterEach(() => {
71 | global.fail = undefined
72 | })
73 |
74 | describe('noConsole()', () => {
75 | it('should fail any files with a console.log in it', async () => {
76 | await noConsole();
77 | expect(global.fail).toHaveBeenCalledTimes(2);
78 | });
79 |
80 | it('should respect the whitelist of console properties', async () => {
81 | await noConsole({ whitelist: ['error'] });
82 | expect(global.fail).toHaveBeenCalledTimes(1);
83 | })
84 | })
85 |
86 |
87 |
danger-plugin-no-console
41 |
42 | 
43 | 
44 |
45 | Danger plugin to prevent merging code that still has console.logs inside it.
46 |
47 |
Usage
48 |
Install:
49 |
yarn add danger-plugin-no-console --dev
50 |
51 |
At a glance:
52 |
// dangerfile.js
53 | import noConsole from 'danger-plugin-no-console'
54 |
55 | noConsole()
56 |
57 |
Changelog
58 |
See the GitHub release history.
59 |
Contributing
60 |
See CONTRIBUTING.md.
61 |
62 |
26 |
27 | 