stripAuthentication does not work as documented

[rendall]

The documentation has these examples regarding stripAuthentication:

normalizeUrl('user:[email protected]');
//=> 'https://sindresorhus.com'

normalizeUrl('user:[email protected]', {stripAuthentication: false});
//=> 'https://user:[email protected]'

However, those examples fail in (Jest) tests:

normalizeUrl › should strip authentication part of the URL by default

    Expected: "https://sindresorhus.com"
    Received: "user:[email protected]"

      24 |   it('should strip authentication part of the URL by default', () => {
    > 25 |     expect(normalizeUrl('user:[email protected]')).toBe('https://sindresorhus.com');
         |                                                            ^
      26 |   });

      at Object.<anonymous> (src/tests/backend/normalizeUrl.test.ts:25:60)

  ● normalizeUrl › should strip authentication part of the URL if stripAuthentication is true

    Expected: "https://sindresorhus.com"
    Received: "user:[email protected]"

      28 |   it('should strip authentication part of the URL if stripAuthentication is true', () => {
    > 29 |     expect(normalizeUrl('user:[email protected]', { stripAuthentication: true })).toBe('https://sindresorhus.com');
         |                                                                                           ^
      30 |   });  

      at Object.<anonymous> (src/tests/backend/normalizeUrl.test.ts:29:91)

These tests do pass, however, if the protocol is included:

  it('should strip authentication part of the URL by default', () => {
    expect(normalizeUrl('https://user:[email protected]')).toBe('https://sindresorhus.com');
  });

  it('should strip authentication part of the URL if stripAuthentication is true', () => {
    expect(normalizeUrl('https://user:[email protected]', { stripAuthentication: true })).toBe('https://sindresorhus.com');
  });  
  
  it('should not strip authentication if stripAuthentication is false', () => {
    expect(normalizeUrl('https://user:[email protected]', { stripAuthentication: false })).toBe('https://user:[email protected]');
  });

[rendall]

This test passes, asking it to strip authentication and protocol:

  it('should strip authentication and protocol', () => {
    expect(normalizeUrl('https://user:[email protected]', {stripProtocol:true}))
        .toBe('sindresorhus.com');
  });

[sindresorhus]

This is by design. I just forgot to document the behavior: 2d0bafe

Also see: https://github.com/sindresorhus/normalize-url/releases/tag/v8.0.0

[rendall]

Understood. My comment was more about the documentation. I submitted PR #185 as a quick documentation fix to get it aligned with the behavior.