@teambit/dependencies 1.0.330 → 1.0.331

package/files-dependency-builder/filing-cabinet/index.ts

@@ -0,0 +1,119 @@
+// @flow
+
+/**
+ * this file had been forked from https://github.com/dependents/node-filing-cabinet
+ */
+import path from 'path';
+import resolveDependencyPath from 'resolve-dependency-path';
+import stylusLookup from 'stylus-lookup';
+
+import { lookupJavaScript, lookupTypeScript } from '@teambit/typescript.deps-lookups.lookup-typescript';
+import { lookupStyling } from '@teambit/styling.deps-lookups.lookup-styling';
+
+import { DependencyDetector, DetectorHook } from '../detector-hook';
+
+const debug = require('debug')('cabinet');
+
+const defaultLookups = {
+  '.js': lookupJavaScript,
+  '.cjs': lookupJavaScript,
+  '.mjs': lookupJavaScript,
+  '.jsx': lookupJavaScript,
+  '.ts': lookupTypeScript,
+  '.tsx': lookupTypeScript,
+  '.cts': lookupTypeScript,
+  '.mts': lookupTypeScript,
+  '.scss': lookupStyling,
+  '.sass': lookupStyling,
+  '.styl': stylusLookup,
+  '.less': lookupStyling,
+};
+
+type Options = {
+  dependency: string; // previous name was "partial"
+  filename: string;
+  directory: string;
+  config: Record<string, any>;
+  webpackConfig?: Record<string, any>;
+  configPath?: string;
+  resolveConfig?: Record<string, any>;
+  isScript?: boolean; // relevant for Vue files
+  ast?: string;
+  ext?: string;
+  content?: string;
+  envDetectors?: DependencyDetector[];
+};
+
+export default function cabinet(options: Options) {
+  const detectorHook = new DetectorHook();
+  const { dependency, filename } = options;
+  const ext = options.ext || path.extname(filename);
+  debug(`working on a dependency "${dependency}" of a file "${filename}"`);
+
+  let resolver = defaultLookups[ext];
+
+  if (!resolver) {
+    debug('using generic resolver');
+    resolver = resolveDependencyPath;
+  }
+  if (ext === '.css' && dependency.startsWith('~')) resolver = lookupStyling;
+
+  const detector = detectorHook.getDetector(ext);
+  if (detector) {
+    // test if the new detector API has a dependency lookup.
+    if (detector.dependencyLookup) {
+      resolver = detector.dependencyLookup;
+    } else {
+      // otherwise use TypeScript as the default resolver.
+      resolver = lookupTypeScript;
+    }
+  }
+
+  if (options?.envDetectors) {
+    for (const envDetector of options.envDetectors) {
+      if (envDetector.isSupported({ ext }) && envDetector.dependencyLookup) {
+        resolver = envDetector.dependencyLookup;
+      }
+    }
+  }
+
+  debug(`found a resolver ${resolver.name} for ${ext}`);
+
+  let result = resolver(options);
+  const dependencyExt = path.extname(dependency);
+  if (!result && dependencyExt && dependencyExt !== ext) {
+    resolver = defaultLookups[dependencyExt];
+    if (resolver) {
+      // todo: this strategy probably fails often. if, for example, a dependency A.js inside B.ts
+      // was not found using the ts resolve, it tries the js resolver, however, parsing the ts file
+      // with js parser, won't work most of the time. A better approach would be to fix the
+      // original resolver.
+      debug(
+        `dependency has a different extension (${dependencyExt}) than the original file (${ext}), trying to use its resolver instead`
+      );
+      try {
+        result = resolver(options);
+      } catch (err: any) {
+        debug(`unable to use the resolver of ${dependencyExt} for ${filename}. got an error ${err.message}`);
+      }
+    }
+  }
+  debug(`resolved path for ${dependency}: ${result}`);
+  return result;
+}
+
+module.exports.supportedFileExtensions = Object.keys(defaultLookups);
+
+/**
+ * Register a custom lookup resolver for a file extension
+ *
+ * @param  {String} extension - The file extension that should use the resolver
+ * @param  {Function} lookupStrategy - A resolver of dependency paths
+ */
+module.exports.register = function (extension, lookupStrategy) {
+  defaultLookups[extension] = lookupStrategy;
+
+  if (this.supportedFileExtensions.indexOf(extension) === -1) {
+    this.supportedFileExtensions.push(extension);
+  }
+};

package/files-dependency-builder/fixtures/build-tree/a.js

@@ -0,0 +1,2 @@
+// @bit-no-check
+const b = require('./b');

package/files-dependency-builder/fixtures/build-tree/b.js

@@ -0,0 +1,2 @@
+// @bit-no-check
+const unparsed = require('./unparsed');

package/files-dependency-builder/fixtures/build-tree/not-link-file/file-a.js

@@ -0,0 +1,2 @@
+// @bit-no-check
+import { varX } from './file-b';

package/files-dependency-builder/fixtures/build-tree/not-link-file/file-b.js

@@ -0,0 +1,4 @@
+// @bit-no-check
+import { varX } from './file-c';
+
+// export { varX }; // uncomment to make the following test fail "fileA imports varX from fileB, fileB imports varX from fileC but not export it"

package/files-dependency-builder/fixtures/build-tree/not-link-file/file-c.js

@@ -0,0 +1,3 @@
+// @bit-no-check
+const varX = 4;
+export { varX };

package/files-dependency-builder/fixtures/build-tree/tree-shaking-cycle/foo.js

@@ -0,0 +1,2 @@
+// @bit-no-check
+import { isString } from '.';

package/files-dependency-builder/fixtures/build-tree/tree-shaking-cycle/index.js

@@ -0,0 +1,2 @@
+// @bit-no-check
+export { default as isString } from './is-string';

package/files-dependency-builder/fixtures/build-tree/tree-shaking-cycle/is-string.js

@@ -0,0 +1,3 @@
+// @bit-no-check
+import { isString } from '.'; // cycle with ./index.js
+export default isString;

package/files-dependency-builder/fixtures/build-tree/tree-shaking-cycle/self-cycle.js

@@ -0,0 +1,3 @@
+// @bit-no-check
+import { selfCycle } from './self-cycle';
+export { selfCycle };

package/files-dependency-builder/fixtures/build-tree/unparsed.js

@@ -0,0 +1,2 @@
+// @bit-no-check
+// this should trigger parsing error

package/files-dependency-builder/fixtures/dependency-tree/amd/a.js

@@ -0,0 +1,6 @@
+// @bit-no-check
+define(['./b', './c'], function(b, c) {
+  'use strict';
+
+  return 'cool';
+});

package/files-dependency-builder/fixtures/dependency-tree/amd/b.js

@@ -0,0 +1,6 @@
+// @bit-no-check
+define(['./c'], function(c) {
+  'use strict';
+
+  return c;
+});

package/files-dependency-builder/fixtures/dependency-tree/amd/c.js

@@ -0,0 +1,2 @@
+// @bit-no-check
+define({});

package/files-dependency-builder/fixtures/dependency-tree/commonjs/a.js

@@ -0,0 +1,2 @@
+var b = require('./b');
+var c = require('./c');

package/files-dependency-builder/fixtures/dependency-tree/commonjs/b.js

@@ -0,0 +1,3 @@
+var path = require('path');
+
+module.exports = {};

package/files-dependency-builder/fixtures/dependency-tree/commonjs/c.js

@@ -0,0 +1,3 @@
+var fs = require('fs');
+
+module.exports = {};

package/files-dependency-builder/fixtures/dependency-tree/onlyRealDeps/a.js

@@ -0,0 +1,4 @@
+// @bit-no-check
+var path = require('path');
+var debug = require('debug');
+var notReal = require('not-real');

package/files-dependency-builder/fixtures/dependency-tree/webpack/aliased.js

@@ -0,0 +1,2 @@
+// @bit-no-check
+var foo = require('F');

package/files-dependency-builder/fixtures/dependency-tree/webpack/unaliased.js

@@ -0,0 +1,2 @@
+// @bit-no-check
+var cabinet = require('filing-cabinet');

package/files-dependency-builder/fixtures/filing-cabinet/ast.js

@@ -0,0 +1,266 @@
+// AST of 'import bar from "./bar";'
+module.exports = {
+  type: 'File',
+  start: 0,
+  end: 24,
+  loc: {
+    start: {
+      line: 1,
+      column: 0
+    },
+    end: {
+      line: 1,
+      column: 24
+    }
+  },
+  program: {
+    type: 'Program',
+    start: 0,
+    end: 24,
+    loc: {
+      start: {
+        line: 1,
+        column: 0
+      },
+      end: {
+        line: 1,
+        column: 24
+      }
+    },
+    sourceType: 'module',
+    body: [
+      {
+        type: 'ImportDeclaration',
+        start: 0,
+        end: 24,
+        loc: {
+          start: {
+            line: 1,
+            column: 0
+          },
+          end: {
+            line: 1,
+            column: 24
+          }
+        },
+        specifiers: [
+          {
+            type: 'ImportDefaultSpecifier',
+            start: 7,
+            end: 10,
+            loc: {
+              start: {
+                line: 1,
+                column: 7
+              },
+              end: {
+                line: 1,
+                column: 10
+              }
+            },
+            local: {
+              type: 'Identifier',
+              start: 7,
+              end: 10,
+              loc: {
+                start: {
+                  line: 1,
+                  column: 7
+                },
+                end: {
+                  line: 1,
+                  column: 10
+                }
+              },
+              name: 'bar'
+            }
+          }
+        ],
+        importKind: 'value',
+        source: {
+          type: 'StringLiteral',
+          start: 16,
+          end: 23,
+          loc: {
+            start: {
+              line: 1,
+              column: 16
+            },
+            end: {
+              line: 1,
+              column: 23
+            }
+          },
+          extra: {
+            rawValue: './bar',
+            raw: '"./bar"'
+          },
+          value: './bar'
+        }
+      }
+    ],
+    directives: []
+  },
+  comments: [],
+  tokens: [
+    {
+      type: {
+        label: 'import',
+        keyword: 'import',
+        beforeExpr: false,
+        startsExpr: false,
+        rightAssociative: false,
+        isLoop: false,
+        isAssign: false,
+        prefix: false,
+        postfix: false,
+        binop: null,
+        updateContext: null
+      },
+      value: 'import',
+      start: 0,
+      end: 6,
+      loc: {
+        start: {
+          line: 1,
+          column: 0
+        },
+        end: {
+          line: 1,
+          column: 6
+        }
+      }
+    },
+    {
+      type: {
+        label: 'name',
+        beforeExpr: false,
+        startsExpr: true,
+        rightAssociative: false,
+        isLoop: false,
+        isAssign: false,
+        prefix: false,
+        postfix: false,
+        binop: null
+      },
+      value: 'bar',
+      start: 7,
+      end: 10,
+      loc: {
+        start: {
+          line: 1,
+          column: 7
+        },
+        end: {
+          line: 1,
+          column: 10
+        }
+      }
+    },
+    {
+      type: {
+        label: 'name',
+        beforeExpr: false,
+        startsExpr: true,
+        rightAssociative: false,
+        isLoop: false,
+        isAssign: false,
+        prefix: false,
+        postfix: false,
+        binop: null
+      },
+      value: 'from',
+      start: 11,
+      end: 15,
+      loc: {
+        start: {
+          line: 1,
+          column: 11
+        },
+        end: {
+          line: 1,
+          column: 15
+        }
+      }
+    },
+    {
+      type: {
+        label: 'string',
+        beforeExpr: false,
+        startsExpr: true,
+        rightAssociative: false,
+        isLoop: false,
+        isAssign: false,
+        prefix: false,
+        postfix: false,
+        binop: null,
+        updateContext: null
+      },
+      value: './bar',
+      start: 16,
+      end: 23,
+      loc: {
+        start: {
+          line: 1,
+          column: 16
+        },
+        end: {
+          line: 1,
+          column: 23
+        }
+      }
+    },
+    {
+      type: {
+        label: ';',
+        beforeExpr: true,
+        startsExpr: false,
+        rightAssociative: false,
+        isLoop: false,
+        isAssign: false,
+        prefix: false,
+        postfix: false,
+        binop: null,
+        updateContext: null
+      },
+      start: 23,
+      end: 24,
+      loc: {
+        start: {
+          line: 1,
+          column: 23
+        },
+        end: {
+          line: 1,
+          column: 24
+        }
+      }
+    },
+    {
+      type: {
+        label: 'eof',
+        beforeExpr: false,
+        startsExpr: false,
+        rightAssociative: false,
+        isLoop: false,
+        isAssign: false,
+        prefix: false,
+        postfix: false,
+        binop: null,
+        updateContext: null
+      },
+      start: 24,
+      end: 24,
+      loc: {
+        start: {
+          line: 1,
+          column: 24
+        },
+        end: {
+          line: 1,
+          column: 24
+        }
+      }
+    }
+  ]
+};

package/files-dependency-builder/fixtures/filing-cabinet/foo.jsx

@@ -0,0 +1,3 @@
+export default () => {
+  return <MySweetComponent />;
+}

package/files-dependency-builder/fixtures/filing-cabinet/foo.scss

@@ -0,0 +1 @@
+@import "~bootstrap/index";

package/files-dependency-builder/fixtures/filing-cabinet/mockedJSFiles.js

@@ -0,0 +1,61 @@
+module.exports = {
+  js: {
+    es6: {
+      'foo.js': 'import bar from "./bar";',
+      'foo.jsx': 'import React from "react"; export default () => { return (<div></div>); }',
+      'bar.js': 'export default function() {};'
+    },
+    cjs: {
+      'foo.js': 'module.exports = 1;',
+      'bar.jsx': 'var React = require("react"); module.exports = function() { return (<div></div>); };',
+      'baz.scss': '.main: {}',
+      'pkg.json': ''
+    },
+    ts: {
+      'index.ts': 'import foo from "./foo";',
+      'foo.ts': 'export default 1;'
+    },
+    amd: {
+      'foo.js': 'define(["./bar"], function(bar){ return bar; });',
+      'bar.js': 'define({});'
+    },
+    commonjs: {
+      'foo.js': 'var bar = require("./bar");',
+      'bar.js': 'module.exports = function() {};',
+      'foo.baz': 'module.exports = "yo";',
+      'index.js': '',
+      'module.entry.js': 'import * as module from "module.entry"',
+      subdir: {
+        'module.js': 'var entry = require("../");',
+        'index.js': ''
+      },
+      test: {
+        'index.spec.js': 'var subdir = require("subdir");'
+      }
+    },
+    node_modules: {
+      'lodash.assign': {
+        'index.js': 'module.exports = function() {};'
+      },
+      'module.entry': {
+        'index.main.js': 'module.exports = function() {};',
+        'index.module.js': 'module.exports = function() {};',
+        'package.json': '{ "main": "index.main.js", "module": "index.module.js" }'
+      },
+      nested: {
+        'index.js': 'require("lodash.assign")',
+        node_modules: {
+          'lodash.assign': {
+            'index.js': 'module.exports = function() {};'
+          }
+        }
+      }
+    },
+    withIndex: {
+      subdir: {
+        'index.js': ''
+      },
+      'index.js': 'var sub = require("./subdir");'
+    }
+  }
+};

package/files-dependency-builder/fixtures/filing-cabinet/root1/mod1.js

@@ -0,0 +1 @@
+module.exports = {};

package/files-dependency-builder/fixtures/filing-cabinet/root2/mod2.js

@@ -0,0 +1 @@
+module.exports = {};

package/files-dependency-builder/fixtures/filing-cabinet/webpack.config.js

@@ -0,0 +1,8 @@
+module.exports = {
+  entry: './index.js',
+  resolve: {
+    alias: {
+      R: './node_modules/resolve'
+    }
+  }
+};

package/files-dependency-builder/fixtures/missing-deps.js

@@ -0,0 +1,2 @@
+// const a = require('non-exist-package'); // missing package
+// const b = require('../non-exist-dep'); // missing dependency

package/files-dependency-builder/fixtures/precinct/Gruntfile.js

@@ -0,0 +1,22 @@
+// @bit-no-check
+module.exports = function(grunt) {
+  grunt.initConfig({
+    jshint: {
+      files: ['Gruntfile.js', 'src/**/*.js', 'test/**/*.js'],
+      options: {
+        globals: {
+          jQuery: true
+        }
+      }
+    },
+    watch: {
+      files: ['<%= jshint.files %>'],
+      tasks: ['jshint']
+    }
+  });
+
+  grunt.loadNpmTasks('grunt-contrib-jshint');
+  grunt.loadNpmTasks('grunt-contrib-watch');
+
+  grunt.registerTask('default', ['jshint']);
+};

package/files-dependency-builder/fixtures/precinct/amd.js

@@ -0,0 +1,2 @@
+// @bit-no-check
+define(['./a', './b'], function(a, b) {});

package/files-dependency-builder/fixtures/precinct/bar.foo

@@ -0,0 +1 @@
+keywords: foo foo foo

package/files-dependency-builder/fixtures/precinct/cjsExportLazy.js

@@ -0,0 +1,7 @@
+// @bit-no-check
+module.exports = function({
+  // Just requiring any files that exist
+  amd = require('./amd'),
+  es6 = require('./es6').foo,
+  es7 = require('./es7')
+}) {};

package/files-dependency-builder/fixtures/precinct/commonjs.js

@@ -0,0 +1,3 @@
+// @bit-no-check
+var a = require('./a'),
+  b = require('./b');

package/files-dependency-builder/fixtures/precinct/coreModules.js

@@ -0,0 +1,5 @@
+// @bit-no-check
+var assert = require('assert');
+var path = require('path');
+var fs = require('fs');
+var nodeFs = require('node:fs');

package/files-dependency-builder/fixtures/precinct/es6.js

@@ -0,0 +1,4 @@
+// @bit-no-check
+import { square, diag } from 'lib';
+console.log(square(11)); // 121
+console.log(diag(4, 3)); // 5

package/files-dependency-builder/fixtures/precinct/es6MixedExportLazy.js

@@ -0,0 +1,7 @@
+// @bit-no-check
+export default function({
+  // Just requiring any files that exist
+  amd = require('./amd'),
+  es6 = require('./es6'),
+  es7 = require('./es7')
+}) {}

package/files-dependency-builder/fixtures/precinct/es7.js

@@ -0,0 +1,3 @@
+// @bit-no-check
+import { square, diag } from 'lib';
+async function foo() {}

package/files-dependency-builder/fixtures/precinct/exampleAST.js

@@ -0,0 +1,32 @@
+module.exports = {
+  type: 'Program',
+  body: [
+    {
+      type: 'VariableDeclaration',
+      declarations: [
+        {
+          type: 'VariableDeclarator',
+          id: {
+            type: 'Identifier',
+            name: 'a'
+          },
+          init: {
+            type: 'CallExpression',
+            callee: {
+              type: 'Identifier',
+              name: 'require'
+            },
+            arguments: [
+              {
+                type: 'Literal',
+                value: './a',
+                raw: './a'
+              }
+            ]
+          }
+        }
+      ],
+      kind: 'var'
+    }
+  ]
+};

package/files-dependency-builder/fixtures/precinct/foo.foo

@@ -0,0 +1 @@
+There is no keywords matched.