fix(options): Add integration tests for version auto-detect

- revert detectedVersion => version
- Fix typedef for FileStructure
- Small code changes
- Small test changes

index.js

@@ -109,9 +109,9 @@ function mergeItems(itemType, currentItem, newItem, ignoreLocations) {
     return currentItem;
 }
 
-function subscribeOnParserEvents(parser, ignoredVisibilities, detectedVersion, resolve, reject) {
+function subscribeOnParserEvents(parser, ignoredVisibilities, version, resolve, reject) {
     const component = {
-        version: detectedVersion
+        version: version
     };
 
     parser.features.forEach((feature) => {
@@ -195,11 +195,11 @@ module.exports.parse = (options) => new Promise((resolve, reject) => {
 
         options.structure = loadFileStructureFromOptions(fileOptions);
 
-        const detectedVersion = options.version || SvelteVersionDetector.detectVersionFromStructure(structure, options.defaultVersion);
+        const version = options.version || SvelteVersionDetector.detectVersionFromStructure(options.structure, options.defaultVersion);
 
-        const parser = buildSvelteParser(options, detectedVersion);
+        const parser = buildSvelteParser(options, version);
 
-        subscribeOnParserEvents(parser, options.ignoredVisibilities, detectedVersion, resolve, reject);
+        subscribeOnParserEvents(parser, options.ignoredVisibilities, version, resolve, reject);
 
         parser.walk();
     } catch (error) {

lib/helpers.js

@@ -4,7 +4,7 @@ const path = require('path');
 /**
  * @typedef {import('../typings').SvelteParserOptions} SvelteParserOptions
  * @typedef {'fileContent' | 'filename' | 'encoding'} FileOptionKeys
- * @typedef {{content?: string; template?: string, scripts?: unknown[], styles?: unknown[] }} FileStructure
+ * @typedef {{content?: string; template?: string, scripts?: HtmlBlock[], styles?: HtmlBlock[] }} FileStructure
  * @typedef {Pick<SvelteParserOptions, FileOptionKeys> & { structure?: FileStructure }} FileOptions
  */
 

lib/options.js

@@ -42,7 +42,7 @@ const ErrorMessage = Object.freeze({
     EncodingNotSupported: (enc) => getUnsupportedEncodingString(enc),
     IgnoredVisibilitiesMissing: 'Internal Error: options.ignoredVisibilities is not set.',
     IgnoredVisibilitiesFormat: ERROR_VISIBILITIES_FORMAT + INFO_VISIBILITIES_SUPPORTED,
-    IgnoredVisibilitiesNotSupported: (arr) => `${getUnsupportedVisibilitiesString(arr)}`,
+    IgnoredVisibilitiesNotSupported: (arr) => getUnsupportedVisibilitiesString(arr),
 });
 
 /** @type {BufferEncoding} */

lib/parser.js

@@ -6,7 +6,6 @@ const path = require('path');
 const utils = require('./utils');
 const jsdoc = require('./jsdoc');
 
-// TODO: Remove this and use from utils directly
 const hasOwnProperty = utils.hasOwnProperty;
 
 const DEFAULT_OPTIONS = {

test/integration/parse/basicV2.svelte

@@ -0,0 +1,3 @@
+<script>
+    export default {};
+</script>

test/integration/parse/basicV3.svelte

@@ -0,0 +1,3 @@
+<script context="module">
+    let staticVariable = 0;
+</script>

test/integration/parse/parse.spec.js

@@ -0,0 +1,35 @@
+const path = require('path');
+const chai = require('chai');
+const expect = chai.expect;
+
+const parser = require('./../../../index');
+
+describe('parse - Integration', () => {
+    it('should correctly auto-detect svelte V2 component', (done) => {
+        parser.parse({
+            filename: path.resolve(__dirname, 'basicV2.svelte'),
+        }).then((doc) => {
+            expect(doc, 'Document should exist').to.exist;
+            // v3-parser converts component name to kebab-case
+            expect(doc.name).to.equal('basic-v2');
+
+            done();
+        }).catch(e => {
+            done(e);
+        });
+    });
+
+    it('should correctly auto-detect svelte V3 component', (done) => {
+        parser.parse({
+            filename: path.resolve(__dirname, 'basicV3.svelte'),
+        }).then((doc) => {
+            expect(doc, 'Document should be provided').to.exist;
+            // v3-parser converts component name to PascalCase
+            expect(doc.name).to.equal('BasicV3');
+
+            done();
+        }).catch(e => {
+            done(e);
+        });
+    });
+});

test/unit/options/options.spec.js

@@ -90,12 +90,7 @@ describe('Options Module', () => {
 
     describe('options.retrieveFileOptions', () => {
         it('Should return all file-related keys from options', () => {
-            const options = {
-                ...baseOptions,
-                ignoredVisibilities: ['protected', 'public']
-            };
-
-            expect(retrieveFileOptions(options)).to.have.keys(
+            expect(retrieveFileOptions(baseOptions)).to.have.keys(
                 'filename', 'fileContent', 'structure', 'encoding'
             );
         });