TS declarations / RemoveEmptyLines / InsertFinalNewLine / TrimLines

[scripthunter7]

TS declarations

• TS declarations for the Hostlist Compiler.
  • Example usage (hostlist.ts):

    import HostlistCompiler, { IConfiguration as HostlistCompilerConfiguration } from '@adguard/hostlist-compiler';
    import { writeFileSync } from 'fs';
    
    (async () => {
        // Configuration
        const config: HostlistCompilerConfiguration = {
            name: 'hufilter DNS filter',
            description: 'Simplified hufilter version specifically to be better compatible with DNS-level ad blocking.',
            homepage: 'https://github.com/hufilter/hufilter/wiki',
            license: 'https://github.com/hufilter/hufilter/blob/master/LICENSE',
            sources: [
                {
                    type: 'adblock',
                    source: 'https://raw.githubusercontent.com/hufilter/hufilter/master/hufilter-adguard.txt',
                    transformations: ['RemoveComments', 'Validate', 'Deduplicate'],
                },
            ],
            transformations: ['RemoveEmptyLines', 'InsertFinalNewLine'],
        };
    
        // Compiled filter list
        const result = await HostlistCompiler(config);
    
        // Write it to file
        writeFileSync('hufilter-dns.txt', result.join('\n'));
    })();

  • VSCode suggestions:
    • Possible values:
      
    • Basic JSDoc:
      

RemoveEmptyLines

This is a very simple transformation that removes empty lines. Related to #30 and #12

Example:

Original list:

rule1

rule2


rule3

Here's what we will have after applying this transformation:

rule1
rule2
rule3

InsertFinalNewLine

This is a very simple transformation that inserts a final new line.

Example:

Original list:

rule1
rule2
rule3

Here's what we will have after applying this transformation:

rule1
rule2
rule3

RemoveEmptyLines transformation has no effect on this new line because it precedes this transformation in the execution queue.

TrimLines

This is a very simple transformation that removes leading and trailing spaces/tabs. Related to #12

Example:

Original list:

rule1
   rule2
rule3
		rule4

Here's what we will have after applying this transformation:

rule1
rule2
rule3
rule4