Documented the case of a scoped package

[ijlee2]

Description

Thanks to @phndiaye's pull request, I realized that the codemod has two bugs:

• The workspaces field in the root package.json should list the package locations, not the package names. A bug would have surfaced when (1) the package is scoped or (2) an end-developer passes the argument --addon-location, --test-app-location, or --test-app-name.
• The regular expression for finding import paths is incorrect when the package is scoped.

References

• https://docs.npmjs.com/cli/v7/using-npm/workspaces#defining-workspaces

  Workspaces are usually defined via the workspaces property of the package.json file, e.g:

  {
    "name": "my-workspaces-powered-project",
    "workspaces": [
      "workspace-a"
    ]
  }

  Given the above package.json example living at a current working directory . that contains a folder named workspace-a that itself contains a package.json inside it, defining a Node.js package, e.g:

  .
  +-- package.json
  `-- workspace-a
     `-- package.json

• https://classic.yarnpkg.com/lang/en/docs/workspaces/#toc-tips-tricks

  The workspaces field is an array containing the paths to each workspace. Since it might be tedious to keep track of each of them, this field also accepts glob patterns! For example, Babel reference all of their packages through a single packages/* directive.

• https://pnpm.io/pnpm-workspace_yaml

  pnpm-workspace.yaml defines the root of the workspace and enables you to include / exclude directories from the workspace. By default, all packages of all subdirectories are included.

  For example:

  packages:
    # all packages in direct subdirs of packages/
    - 'packages/*'
    # all packages in subdirs of components/
    - 'components/**'
    # exclude packages that are inside test directories
    - '!**/test/**'

[ijlee2]

The word boundary \b in the beginning led to incorrect matches when the package name is scoped (because projectName starts with a non-word character @).

By being more specific about the boundaries (i.e. the file path has to be surrounded by single or double quotation marks), we can also avoid false positives, as evidenced in 0fee1ed.

[phndiaye]

Thanks for this, @ijlee2 ! It will help a lot for the next addons I'm going to convert :)