Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Type acquisition support for bower_components directory #14100

Merged
merged 2 commits into from
Mar 30, 2017

Conversation

jramsay
Copy link
Member

@jramsay jramsay commented Feb 15, 2017

Fixes #13917 [Type Acquisition] auto d.ts acquisition no longer works for bower_components

Issue: retrieving typing names from the bower_components directory is not currently supported. We only retrieve typings for bower components when a bower.json is present. By default in VS, ASP.NET projects do not create a bower.json when using the Manage Bower Packages option. No typings are currently being acquired for these components.

Fix:

  1. Apply getTypingNamesFromPackagesFolder that is already being used to retrieve typings for the node_modules folder to the bower_components folder.
  2. Include the packagesFolder(s) in the list of filesToWatch.

@jramsay
Copy link
Member Author

jramsay commented Feb 15, 2017

//cc: @vladima , @mhegazy , @zhengbli , @billti

*/
function getTypingNamesFromNodeModuleFolder(nodeModulesPath: string) {
function getTypingNamesFromPackagesFolder(packagesFolderPath: string) {
filesToWatch.push(packagesFolderPath);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we watch the path after confirming it exists?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I kept this before the path existence check as we want to watch these paths even if they haven't been created yet. (ex: User creates an empty ASP.NET project, adds a js file then uses Manage Bower Packages to install jQuery.)

installer.installAll(/*expectedCount*/ 1);

checkNumberOfProjects(projectService, { configuredProjects: 1 });
checkProjectActualFiles(p, [app.path, jqueryDTS.path]);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you also check what paths are being watched?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea - will add this to the test

return;
}

const typingNames: string[] = [];
const fileNames = host.readDirectory(nodeModulesPath, [".json"], /*excludes*/ undefined, /*includes*/ undefined, /*depth*/ 2);
const fileNames = host.readDirectory(packagesFolderPath, [".json"], /*excludes*/ undefined, /*includes*/ undefined, /*depth*/ 2);
for (const fileName of fileNames) {
const normalizedFileName = normalizePath(fileName);
if (getBaseFileName(normalizedFileName) !== "package.json") {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For bower, should be checking bower.json instead

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, line 228 and below have some logics specifically targetting npm 3, now we should check if the json file name is package.json before applying these logics.

Copy link
Member Author

@jramsay jramsay Feb 16, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We already retrieve the bower.json typings using getTypingsFromJson(bowerJsonPath, filesToWatch). This addresses the case when there is no bower.json present and just a bower_components folder that contains the packages. From my tests the bower_components folder is similar to the node_modules folder. It contains a directory for each package with a package.json (bower_components/jQuery/package.json). I've been testing using the ASP.NET UI. Let me try bower cmd line and see if this is consistent...
You're correct - from the cmd line install there isn't always a package.json generated. I'll have to check bower.json as well. thanks!

@zhengbli
Copy link
Contributor

👍

@jramsay jramsay merged commit 2e313ca into master Mar 30, 2017
@mhegazy mhegazy deleted the BowerComponentsFix branch November 2, 2017 21:04
@microsoft microsoft locked and limited conversation to collaborators Jun 19, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants