devdocs/lib/docs/scrapers/npm.rb

module Docs
  class Npm < UrlScraper
    self.name = 'npm'
    self.type = 'npm'
    self.release = '10.2.5'
    self.base_url = 'https://docs.npmjs.com/'
    self.force_gzip = true
    self.links = {
      home: 'https://www.npmjs.com/',
      code: 'https://github.com/npm/npm'
    }

    html_filters.push 'npm/entries', 'npm/clean_html'

    options[:download_images] = false
    # options[:max_image_size] = 130_000

    options[:skip] = [
      'all',
      'misc/index',
      'cli',
      'organizations/',
      'orgs',
      'removing-members-from-your-org',
      'adding-members-to-your-org',
      'downloading-and-installing-packages',
    ]

    options[:skip_patterns] = [
      /\Aenterprise/,
      /\Acompany/,
      /\Apolicies/,
      /cli\/v6/,
      /cli\/v7/,
      /cli\/v8/,
      /cli\/v9/,
      /\/\Z/ # avoid pages with a trailing slash, those pages mess up the entries
    ]

    options[:attribution] = <<-HTML
      &copy; npm, Inc. and Contributors<br>
      Licensed under the npm License.<br>
      npm is a trademark of npm, Inc.
    HTML

    #  fix duplicates
    options[:fix_urls] = -> (url) do
      url.sub!('private-modules/intro', 'creating-and-publishing-private-packages')
      url.sub!('managing-team-access-to-packages', 'managing-team-access-to-organization-packages')
      url.sub!('accepting-or-rejecting-an-org-invitation', 'accepting-or-rejecting-an-organization-invitation')
      url.sub!('org-roles-and-permissions', 'organization-roles-and-permissions')
      url.sub!('upgrading-to-a-paid-org-plan', 'upgrading-to-a-paid-organization-plan')
      url.sub!('managing-team-access-to-org-packages', 'managing-team-access-to-organization-packages')
      url.sub!('about-package-json-and-package-lock-json-files', 'creating-a-package-json-file')
      url.sub!('cli/npm', 'cli/v8/commands/npm/')
      url.sub!('cli/config', 'cli/v8/commands/npm-config/')
      url.sub!('misc/registry', 'cli/v8/using-npm/registry/')
      url.sub!('cli-documentation', 'cli/v8')
      url.sub!('cli-documentation/files/npmrc', 'cli/v8/configuring-npm/npmrc/')
      url.sub!('configuring-your-registry-settings-as-an-npm-enterprise-user', 'enterprise')
      url.sub!('cli/publish', 'cli/v8/commands/npm-publish/')
      url.sub!('cli/deprecate', 'cli/v8/commands/npm-deprecate/')
      url.sub!('cli/access', 'cli/v8/commands/npm-access/')
      url.sub!('cli/adduser', 'cli/v8/commands/npm-adduser/')
      url.sub!('misc/config', 'cli/v8/using-npm/config/')
      url.sub!('cli/token', 'cli/v8/commands/npm-token/')
      url.sub!('cli/unpublish', 'cli/v8/commands/npm-unpublish/')
      url.sub!('files/package.json', 'cli/v8/configuring-npm/package-json/')
      url.sub!('cli/profile', 'cli/v8/commands/npm-profile/')
      url.sub!('creating-a-packge-json-file', 'cli/v8/configuring-npm/package-json/')
      url.sub!('cli/dist-tag', 'cli/v8/commands/npm-dist-tag/')
      url.sub!('cli/team', 'cli/v8/commands/npm-team/')
      url.sub!('cli/version', 'cli/v8/commands/npm-version/')
      url.sub!('cli/owner', 'cli/v8/commands/npm-owner/')
      url.sub!('cli/install', '/cli/v8/commands/npm-install/')
      url.sub!('cli/audit', 'cli/v8/commands/npm-audit/')
      url.sub!('cli/update', 'cli/v8/commands/npm-update/')
      url.sub!('cli/outdated', 'cli/v8/commands/npm-outdated/')
      url.sub!('cli/uninstall', 'cli/v8/commands/npm-uninstall/')
      url.sub!('misc/developers', 'cli/v8/using-npm/developers//')
      url
    end

    def get_latest_version(opts)
      get_latest_github_release('npm', 'cli', opts)
    end

  end
end