Nearest Phase Modulator

    dedupe-assert
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.2 • Public • Published

    dedupe-assert

    asserts that packages are truly deduped

    main JavaScript Style Guide TypeScript package

    install

    npm install [--save|--save-dev] dedupe-assert

    usage

    $ dedupe-assert --help
     
      Usage
        $ dedupe-assert --matches=<pattern> [/path/to/project]
     
      Options
        --matches, -m  Add one or many matches, in string or JS regex style, csv separated
     
      Examples
     
        # assert one thing deduped 
        $ dedupe-assert --matches=debug
     
        # assert web things deduped 
        $ dedupe-assert --matches=react,/webpack-*/,redux .
     
        # assert all things dedepud 
        $ dedupe-assert --matches=/.*/
     

    when run on this very package, you can see not all dependencies are actually deduped:

    $ dedupe-assert --matches=/.*/
    [dedupe-assert] resolving dependencies
    [dedupe-assert] creating report
    [dedupe-assert] 🚨 The following packages are required to be deduped but have >1 versions
    [dedupe-assert] resolving dependencies
    [dedupe-assert] creating report
    ┌─────────┬────────────────────────────────────────┬─────────────────────────────────────┐
    │ (index) │                  name                  │              versions               │
    ├─────────┼────────────────────────────────────────┼─────────────────────────────────────┤
    │    0    │          '@babel/code-frame'           │           '7.8.3, 7.5.5'            │
    │    1    │             '@types/node'              │          '6.14.9, 13.9.2'           │
    │    2    │ '@typescript-eslint/typescript-estree' │           '2.24.0, 2.6.1'           │
    │    3    │             'ansi-escapes'             │           '3.2.0, 4.3.1'            │
    |  ...    |       ... truncated for readme ...     |            ...                      |
    │   92    │             'yargs-parser'             │          '18.1.1, 10.1.0'           │
    └─────────┴────────────────────────────────────────┴─────────────────────────────────────┘
    
    

    😵!

    to use a library:

    import { assess, report } from 'dedupe-assert'
    const { conflictedDepsByName } = await assess({ dirname: '/path/to/project' })
    const report = await getReport({
      conflictedDepsByName,
      alertOnMatches: ['react', /best-package$/]
    })
    // then do great stuff.  see `src/` dir for TS interfaces

    why

    npm dedupe (and similar functions from other package managers) attempt to dedupe packages to save disk space and reuse package instances. in many cases, not deduping can actually break your application.

    for instance, some packages may be stateful and expect to be singletons. if such packages are not deduped, code files consuming those package may break as they can end up referencing different instances, when they thought they were sharing.

    dedupe-assert guarantees that packages are both logically and physically deduped.

    Install

    npm i dedupe-assert

    DownloadsWeekly Downloads

    0

    Version

    1.0.2

    License

    ISC

    Unpacked Size

    27.5 kB

    Total Files

    14

    Last publish

    Collaborators

    • cdaringe