puppeteer/utils/doclint/Message.js
Andrey Lushnikov 75a8d7b0c3 [doclint] Prepare doclint for more checks
This patch refactors doclint so that more checks and more generators
could be added.

This patch:
- Introduces 'Source' class, which holds file content in-memory and
  allows it to be updated.
- Introduces 'Message' class - which is a pair of a text and a type.
  Messages could have either 'error' type or 'warning' type.
2017-07-31 00:10:59 -07:00

45 lines
1.0 KiB
JavaScript

/**
* Copyright 2017 Google Inc. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
class Message {
/**
* @param {string} type
* @param {string} text
*/
constructor(type, text) {
this.type = type;
this.text = text;
}
/**
* @param {string} text
* @return {!Message}
*/
static error(text) {
return new Message('error', text);
}
/**
* @param {string} text
* @return {!Message}
*/
static warning(text) {
return new Message('warning', text);
}
}
module.exports = Message;