Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Formats the input source code by adding appropriate indentation to specific HTML elements. #16795

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Formats the input source code by adding appropriate indentation to specific HTML elements. #16795

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7d42177
Formats the input source code by adding appropriate indentation to sp…
Jun 14, 2024
393eb0b
fix indent for tag after inline tags.
Jul 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
159 changes: 146 additions & 13 deletions packages/ckeditor5-source-editing/src/sourceediting.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -407,25 +407,158 @@ export default class SourceEditing extends Plugin {
}

/**
* Formats the content for a better readability.
* Formats the input source code by adding appropriate indentation to specific HTML elements.
*
* For a non-HTML source the unchanged input string is returned.
*
* @param input Input string to check.
* @param input - The input source code to be formatted.
* @returns The formatted source code with added indentation.
*/
function formatSource( input: string ): string {
if ( !isHtml( input ) ) {
return input;
}
const elementsToFormat: Array<ElementToFormat> = [
{ name: 'ul', isIndented: true, isInline: false },
{ name: 'ul', isIndented: true, isInline: false },
{ name: 'ol', isIndented: true, isInline: false },
{ name: 'div', isIndented: true, isInline: false },
{ name: 'aside', isIndented: true, isInline: false },
{ name: 'table', isIndented: true, isInline: false },
{ name: 'thead', isIndented: true, isInline: false },
{ name: 'tbody', isIndented: true, isInline: false },
{ name: 'tr', isIndented: true, isInline: false },
{ name: 'tfoot', isIndented: true, isInline: false },
{ name: 'blockquote', isIndented: true, isInline: false },
{ name: 'figure', isIndented: true, isInline: false },
{ name: 'dl', isIndented: true, isInline: false },
{ name: 'br', isIndented: true, isInline: false },
{ name: 'p', isIndented: false, isInline: false },
{ name: 'h2', isIndented: false, isInline: false },
{ name: 'h3', isIndented: false, isInline: false },
{ name: 'h4', isIndented: false, isInline: false },
{ name: 'h5', isIndented: false, isInline: false },
{ name: 'h6', isIndented: false, isInline: false },
{ name: 'a', isIndented: false, isInline: true },
{ name: 'li', isIndented: false, isInline: false },
{ name: 'dt', isIndented: false, isInline: false },
{ name: 'dd', isIndented: false, isInline: false },
{ name: 'span', isIndented: false, isInline: true },
{ name: 'sup', isIndented: false, isInline: true },
{ name: 'sub', isIndented: false, isInline: true },
{ name: 'strong', isIndented: false, isInline: true },
{ name: 'i', isIndented: false, isInline: true },
{ name: 'cite', isIndented: false, isInline: true },
{ name: 'em', isIndented: false, isInline: true },
{ name: 'img', isIndented: false, isInline: true },
{ name: 'abbr', isIndented: false, isInline: true },
{ name: 'onesite-phone', isIndented: false, isInline: true },
{ name: 'onesite-fax', isIndented: false, isInline: true },
{ name: 'onesite-ref', isIndented: false, isInline: true },
{ name: 'onesite-spa', isIndented: false, isInline: true },
{ name: 'onesite-interactive-table', isIndented: false, isInline: true },
{ name: 'iframe', isIndented: false, isInline: false },
{ name: 'svg', isIndented: false, isInline: true },
{ name: 'caption', isIndented: false, isInline: false },
{ name: 'figcaption', isIndented: false, isInline: false },
{ name: 'hr', isIndented: false, isInline: false },
{ name: 'q', isIndented: false, isInline: true },
{ name: 'small', isIndented: false, isInline: true },
{ name: 'td', isIndented: false, isInline: false },
{ name: 'th', isIndented: false, isInline: false }
];
const elementNamesToFormat = elementsToFormat.map( element => element.name ).join( '|' );

let lastElementType = '';

const lines = input
.replace(
new RegExp(
`</?( ${ elementNamesToFormat })( .*?)?>|</( ${ elementNamesToFormat })>`,
'g'
),
( match, p1, p3 ) => {
const elementToFormat = elementsToFormat.find(
element => element.name === p1 || element.name === p3
);
if ( elementToFormat ) {
let modifiedMatch = match;
// Check if the current element is 'isIndented' and the last seen element was 'isInline'
if ( elementToFormat.isIndented && lastElementType === 'isInline' ) {
modifiedMatch = `\n${ match }`;
}
// Update lastElementType based on the current element
if ( elementToFormat.isInline ) {
lastElementType = 'isInline';
} else if ( elementToFormat.isIndented ) {
lastElementType = 'isIndented';
} else {
lastElementType = '';
}
if ( elementToFormat.isIndented ) {
return `${ modifiedMatch }\n`;
} else if ( match.startsWith( '</' ) && !elementToFormat.isInline ) {
return `${ modifiedMatch }\n`;
}
}
return match;
}
)
// Divide input string into lines.
.split( '\n' );
let indentCount = 0;
const indentChar = ' ';
const indentLine = function( line: string, indentCount: number ): string {
return `${ indentChar.repeat( Math.max( 0, indentCount ) ) }${ line }`;
};

lines.forEach( ( line, index ) => {
const openingTagMatch = line.match( /<(\w+)[^>]*>/g );
const closingTagMatch = line.match( /<\/(\w+)>/g );
if ( openingTagMatch ) {
openingTagMatch.forEach( openingTag => {
const tagNameMatch = openingTag.match( /<(\w+)/ );
const tagName = tagNameMatch ? tagNameMatch[ 1 ] : null;
const elementToFormat = elementsToFormat.find( element => element.name === tagName );
if ( elementToFormat && elementToFormat.isIndented ) {
lines[ index ] = indentLine( line, indentCount );
indentCount++;
} else {
lines[ index ] = indentLine( line, indentCount );
}
} );
} else if ( closingTagMatch ) {
closingTagMatch.forEach( closingTag => {
const tagNameMatch = closingTag.match( /<\/(\w+)>/ );
const tagName = tagNameMatch ? tagNameMatch[ 1 ] : null;
const elementToFormat = elementsToFormat.find( element => element.name === tagName );
if ( elementToFormat && elementToFormat.isIndented ) {
indentCount--;
}
lines[ index ] = indentLine( line, indentCount );
} );
} else {
lines[ index ] = indentLine( line, indentCount );
}
} );

return formatHtml( input );
return lines
.filter( line => line.length )
.join( '\n' );
}

/**
* Checks, if the document source is HTML. It is sufficient to just check the first character from the document data.
*
* @param input Input string to check.
* Element to be formatted.
*/
function isHtml( input: string ): boolean {
return input.startsWith( '<' );
interface ElementToFormat {

/**
* Element name.
*/
name: string;

/**
* Flag indicating whether element is indented.
*/
isIndented: boolean;

/**
* Flag indicating whether element is inline.
*/
isInline: boolean;
}