545563e776
- Complete NestJS TypeScript implementation with WebSocket support - Direct messaging (DM) and group chat functionality - End-to-end encryption with AES encryption and key pairs - Media file support (images, videos, audio, documents) up to 100MB - Push notifications with Firebase Cloud Messaging integration - Mention alerts and real-time typing indicators - User authentication with JWT and Passport - SQLite database with TypeORM entities and relationships - Comprehensive API documentation with Swagger/OpenAPI - File upload handling with secure access control - Online/offline status tracking and presence management - Message editing, deletion, and reply functionality - Notification management with automatic cleanup - Health check endpoint for monitoring - CORS configuration for cross-origin requests - Environment-based configuration management - Structured for Flutter SDK integration Features implemented: ✅ Real-time messaging with Socket.IO ✅ User registration and authentication ✅ Direct messages and group chats ✅ Media file uploads and management ✅ End-to-end encryption ✅ Push notifications ✅ Mention alerts ✅ Typing indicators ✅ Message read receipts ✅ Online status tracking ✅ File access control ✅ Comprehensive API documentation Ready for Flutter SDK development and production deployment.
305 lines
9.8 KiB
JavaScript
305 lines
9.8 KiB
JavaScript
/**
|
|
* @file Runs `prettier` as an ESLint rule.
|
|
* @author Andres Suarez
|
|
*/
|
|
|
|
// @ts-check
|
|
|
|
/**
|
|
* @import {AST, ESLint, Linter, Rule, SourceCode} from 'eslint'
|
|
* @import {Position} from 'estree'
|
|
* @import {FileInfoOptions, Options as PrettierOptions} from 'prettier'
|
|
* @import {Difference} from 'prettier-linter-helpers'
|
|
*/
|
|
|
|
/**
|
|
* @typedef {PrettierOptions & {
|
|
* onDiskFilepath: string;
|
|
* parserMeta?: ESLint.ObjectMetaProperties['meta'];
|
|
* parserPath?: string;
|
|
* usePrettierrc?: boolean;
|
|
* }} Options
|
|
*
|
|
*
|
|
* @typedef {(
|
|
* source: string,
|
|
* options: Options,
|
|
* fileInfoOptions: FileInfoOptions,
|
|
* ) => string} PrettierFormat
|
|
*/
|
|
|
|
'use strict';
|
|
|
|
// ------------------------------------------------------------------------------
|
|
// Requirements
|
|
// ------------------------------------------------------------------------------
|
|
|
|
const {
|
|
showInvisibles,
|
|
generateDifferences,
|
|
} = require('prettier-linter-helpers');
|
|
const { name, version } = require('./package.json');
|
|
|
|
// ------------------------------------------------------------------------------
|
|
// Constants
|
|
// ------------------------------------------------------------------------------
|
|
|
|
const { INSERT, DELETE, REPLACE } = generateDifferences;
|
|
|
|
// ------------------------------------------------------------------------------
|
|
// Privates
|
|
// ------------------------------------------------------------------------------
|
|
|
|
// Lazily-loaded Prettier.
|
|
/** @type {PrettierFormat} */
|
|
let prettierFormat;
|
|
|
|
// ------------------------------------------------------------------------------
|
|
// Rule Definition
|
|
// ------------------------------------------------------------------------------
|
|
|
|
/** @type {WeakMap<SourceCode, number[]>} */
|
|
const lineIndexesCache = new WeakMap();
|
|
|
|
/**
|
|
* Ponyfill `sourceCode.getLocFromIndex` when it's unavailable.
|
|
*
|
|
* See also `getLocFromIndex` in `@eslint/js`.
|
|
*
|
|
* @param {SourceCode} sourceCode
|
|
* @param {number} index
|
|
* @returns {Position}
|
|
*/
|
|
function getLocFromIndex(sourceCode, index) {
|
|
if (typeof sourceCode.getLocFromIndex === 'function') {
|
|
return sourceCode.getLocFromIndex(index);
|
|
}
|
|
|
|
let lineIndexes = lineIndexesCache.get(sourceCode);
|
|
if (!lineIndexes) {
|
|
lineIndexes = [...sourceCode.text.matchAll(/\r?\n/g)].map(
|
|
match => match.index,
|
|
);
|
|
// first line in the file starts at byte offset 0
|
|
lineIndexes.unshift(0);
|
|
lineIndexesCache.set(sourceCode, lineIndexes);
|
|
}
|
|
|
|
let line = 0;
|
|
while (line + 1 < lineIndexes.length && lineIndexes[line + 1] < index) {
|
|
line += 1;
|
|
}
|
|
const column = index - lineIndexes[line];
|
|
|
|
return { line: line + 1, column };
|
|
}
|
|
|
|
/**
|
|
* Reports a difference.
|
|
*
|
|
* @param {Rule.RuleContext} context - The ESLint rule context.
|
|
* @param {Difference} difference - The difference object.
|
|
* @returns {void}
|
|
*/
|
|
function reportDifference(context, difference) {
|
|
const { operation, offset, deleteText = '', insertText = '' } = difference;
|
|
/** @type {AST.Range} */
|
|
const range = [offset, offset + deleteText.length];
|
|
// `context.getSourceCode()` was deprecated in ESLint v8.40.0 and replaced
|
|
// with the `sourceCode` property.
|
|
// TODO: Only use property when our eslint peerDependency is >=8.40.0.
|
|
const sourceCode = context.sourceCode ?? context.getSourceCode();
|
|
|
|
const [start, end] = range.map(index => getLocFromIndex(sourceCode, index));
|
|
|
|
context.report({
|
|
messageId: operation,
|
|
data: {
|
|
deleteText: showInvisibles(deleteText),
|
|
insertText: showInvisibles(insertText),
|
|
},
|
|
loc: { start, end },
|
|
fix: fixer => fixer.replaceTextRange(range, insertText),
|
|
});
|
|
}
|
|
|
|
// ------------------------------------------------------------------------------
|
|
// Module Definition
|
|
// ------------------------------------------------------------------------------
|
|
|
|
/** @type {ESLint.Plugin} */
|
|
const eslintPluginPrettier = {
|
|
meta: { name, version },
|
|
configs: {
|
|
recommended: {
|
|
extends: ['prettier'],
|
|
plugins: ['prettier'],
|
|
rules: {
|
|
'prettier/prettier': 'error',
|
|
'arrow-body-style': 'off',
|
|
'prefer-arrow-callback': 'off',
|
|
},
|
|
},
|
|
},
|
|
rules: {
|
|
prettier: {
|
|
meta: {
|
|
docs: {
|
|
url: 'https://github.com/prettier/eslint-plugin-prettier#options',
|
|
},
|
|
type: 'layout',
|
|
fixable: 'code',
|
|
schema: [
|
|
// Prettier options:
|
|
{
|
|
type: 'object',
|
|
properties: {},
|
|
additionalProperties: true,
|
|
},
|
|
{
|
|
type: 'object',
|
|
properties: {
|
|
usePrettierrc: { type: 'boolean' },
|
|
fileInfoOptions: {
|
|
type: 'object',
|
|
properties: {},
|
|
additionalProperties: true,
|
|
},
|
|
},
|
|
additionalProperties: true,
|
|
},
|
|
],
|
|
messages: {
|
|
[INSERT]: 'Insert `{{ insertText }}`',
|
|
[DELETE]: 'Delete `{{ deleteText }}`',
|
|
[REPLACE]: 'Replace `{{ deleteText }}` with `{{ insertText }}`',
|
|
},
|
|
},
|
|
create(context) {
|
|
const options = /** @type {Options | undefined} */ (context.options[1]);
|
|
const usePrettierrc = !options || options.usePrettierrc !== false;
|
|
/** @type {FileInfoOptions} */
|
|
const fileInfoOptions = options?.fileInfoOptions || {};
|
|
|
|
// `context.getSourceCode()` was deprecated in ESLint v8.40.0 and replaced
|
|
// with the `sourceCode` property.
|
|
// TODO: Only use property when our eslint peerDependency is >=8.40.0.
|
|
const sourceCode = /** @type {SourceCode} */ (
|
|
context.sourceCode ?? context.getSourceCode()
|
|
);
|
|
// `context.getFilename()` was deprecated in ESLint v8.40.0 and replaced
|
|
// with the `filename` property.
|
|
// TODO: Only use property when our eslint peerDependency is >=8.40.0.
|
|
const filepath = context.filename ?? context.getFilename();
|
|
|
|
// Processors that extract content from a file, such as the markdown
|
|
// plugin extracting fenced code blocks may choose to specify virtual
|
|
// file paths. If this is the case then we need to resolve prettier
|
|
// config and file info using the on-disk path instead of the virtual
|
|
// path.
|
|
// `context.getPhysicalFilename()` was deprecated in ESLint v8.40.0 and replaced
|
|
// with the `physicalFilename` property.
|
|
// TODO: Only use property when our eslint peerDependency is >=8.40.0.
|
|
const onDiskFilepath =
|
|
context.physicalFilename ?? context.getPhysicalFilename();
|
|
const source = sourceCode.text;
|
|
|
|
return {
|
|
/** @param {unknown} node */
|
|
[sourceCode.ast.type](node) {
|
|
if (!prettierFormat) {
|
|
// Prettier is expensive to load, so only load it if needed.
|
|
prettierFormat = /** @type {PrettierFormat} */ (
|
|
require('synckit').createSyncFn(require.resolve('./worker.mjs'))
|
|
);
|
|
}
|
|
|
|
/** @type {PrettierOptions} */
|
|
const eslintPrettierOptions = context.options[0] || {};
|
|
|
|
const parser = /** @type {Linter.Parser | undefined} */ (
|
|
context.languageOptions?.parser
|
|
);
|
|
|
|
// prettier.format() may throw a SyntaxError if it cannot parse the
|
|
// source code it is given. Usually for JS files this isn't a
|
|
// problem as ESLint will report invalid syntax before trying to
|
|
// pass it to the prettier plugin. However this might be a problem
|
|
// for non-JS languages that are handled by a plugin. Notably Vue
|
|
// files throw an error if they contain unclosed elements, such as
|
|
// `<template><div></template>. In this case report an error at the
|
|
// point at which parsing failed.
|
|
/** @type {string} */
|
|
let prettierSource;
|
|
try {
|
|
prettierSource = prettierFormat(
|
|
source,
|
|
{
|
|
...eslintPrettierOptions,
|
|
filepath,
|
|
onDiskFilepath,
|
|
parserMeta:
|
|
parser &&
|
|
(parser.meta ?? {
|
|
name: parser.name,
|
|
version: parser.version,
|
|
}),
|
|
parserPath: context.parserPath,
|
|
usePrettierrc,
|
|
},
|
|
fileInfoOptions,
|
|
);
|
|
} catch (err) {
|
|
if (!(err instanceof SyntaxError)) {
|
|
throw err;
|
|
}
|
|
|
|
let message = 'Parsing error: ' + err.message;
|
|
|
|
const error = /**
|
|
* @type {SyntaxError & {
|
|
* codeFrame: string;
|
|
* loc?: AST.SourceLocation;
|
|
* }}
|
|
*/ (err);
|
|
|
|
// Prettier's message contains a codeframe style preview of the
|
|
// invalid code and the line/column at which the error occurred.
|
|
// ESLint shows those pieces of information elsewhere already so
|
|
// remove them from the message
|
|
if (error.codeFrame) {
|
|
message = message.replace(`\n${error.codeFrame}`, '');
|
|
}
|
|
if (error.loc) {
|
|
message = message.replace(/ \(\d+:\d+\)$/, '');
|
|
context.report({ message, loc: error.loc });
|
|
} else {
|
|
context.report({ message, node });
|
|
}
|
|
|
|
return;
|
|
}
|
|
|
|
if (prettierSource == null) {
|
|
return;
|
|
}
|
|
|
|
if (source !== prettierSource) {
|
|
const differences = generateDifferences(source, prettierSource);
|
|
|
|
for (const difference of differences) {
|
|
reportDifference(
|
|
/** @type {Rule.RuleContext} */ (context),
|
|
difference,
|
|
);
|
|
}
|
|
}
|
|
},
|
|
};
|
|
},
|
|
},
|
|
},
|
|
};
|
|
|
|
module.exports = eslintPluginPrettier;
|