oxc-parser 0.53.0 → 0.54.0

package/README.md

@@ -2,15 +2,52 @@
 
 ## Features
 
-- Returns ESM information.
+### Fast Mode
 
-## Caveat
+By default, Oxc parser does not produce semantic errors where symbols and scopes are needed.
 
-The parser alone does not fully check for syntax errors that are associated with semantic data (symbols and scopes).
-The full compiler is needed for such case, as the compiler does an additional semantic pass.
+To enable semantic errors, apply the option `showSemanticErrors: true`.
 
-With this caveat, `oxc-parser` is best suited for parser plugins,
-where you need quick access to ESM information, as well as fast `magic-string` operations.
+For example,
+
+```js
+let foo;
+let foo;
+```
+
+Does not produce any errors when `showSemanticErrors` is `false`, which is the default behavior.
+
+This mode is best suited for parser plugins, where other parts of your build pipeline has already checked for errors.
+
+### Returns ESM information.
+
+It is likely that you are writing a parser plugin that requires ESM information.
+
+To avoid walking the AST again, Oxc Parser returns ESM information directly.
+
+This information can be used to rewrite import and exports with the help of [`magic-string`](https://www.npmjs.com/package/magic-string),
+without any AST manipulations.
+
+```ts
+export interface EcmaScriptModule {
+  /**
+   * Has ESM syntax.
+   *
+   * i.e. `import` and `export` statements, and `import.meta`.
+   *
+   * Dynamic imports `import('foo')` are ignored since they can be used in non-ESM files.
+   */
+  hasModuleSyntax: boolean;
+  /** Import statements. */
+  staticImports: Array<StaticImport>;
+  /** Export statements. */
+  staticExports: Array<StaticExport>;
+  /** Dynamic import expressions. */
+  dynamicImports: Array<DynamicImport>;
+  /** Span positions` of `import.meta` */
+  importMetas: Array<Span>;
+}
+```
 
 ## API
 

package/bindings.js

@@ -377,5 +377,4 @@ module.exports.ExportLocalNameKind = nativeBinding.ExportLocalNameKind
 module.exports.ImportNameKind = nativeBinding.ImportNameKind
 module.exports.parseAsync = nativeBinding.parseAsync
 module.exports.parseSync = nativeBinding.parseSync
-module.exports.parseWithoutReturn = nativeBinding.parseWithoutReturn
 module.exports.Severity = nativeBinding.Severity

package/index.d.ts

@@ -141,21 +141,22 @@ export interface ParserOptions {
    * (non-standard) `ParenthesizedExpression` nodes that have a single `expression` property
    * containing the expression inside parentheses.
    *
-   * Default: true
+   * @default true
    */
   preserveParens?: boolean
+  /**
+   * Produce semantic errors with an additional AST pass.
+   * Semantic errors depend on symbols and scopes, where the parser does not construct.
+   * This adds a small performance overhead.
+   *
+   * @default false
+   */
+  showSemanticErrors?: boolean
 }
 
 /** Parse synchronously. */
 export declare function parseSync(filename: string, sourceText: string, options?: ParserOptions | undefined | null): ParseResult
 
-/**
- * Parse without returning anything.
- *
- * This is for benchmark purposes such as measuring napi communication overhead.
- */
-export declare function parseWithoutReturn(filename: string, sourceText: string, options?: ParserOptions | undefined | null): void
-
 export declare const enum Severity {
   Error = 'Error',
   Warning = 'Warning',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oxc-parser",
-  "version": "0.53.0",
+  "version": "0.54.0",
   "description": "Oxc Parser Node API",
   "keywords": [
     "Parser"
@@ -24,16 +24,16 @@
     "bindings.js"
   ],
   "dependencies": {
-    "@oxc-project/types": "^0.53.0"
+    "@oxc-project/types": "^0.54.0"
   },
   "optionalDependencies": {
-    "@oxc-parser/binding-win32-x64-msvc": "0.53.0",
-    "@oxc-parser/binding-win32-arm64-msvc": "0.53.0",
-    "@oxc-parser/binding-linux-x64-gnu": "0.53.0",
-    "@oxc-parser/binding-linux-arm64-gnu": "0.53.0",
-    "@oxc-parser/binding-linux-x64-musl": "0.53.0",
-    "@oxc-parser/binding-linux-arm64-musl": "0.53.0",
-    "@oxc-parser/binding-darwin-x64": "0.53.0",
-    "@oxc-parser/binding-darwin-arm64": "0.53.0"
+    "@oxc-parser/binding-win32-x64-msvc": "0.54.0",
+    "@oxc-parser/binding-win32-arm64-msvc": "0.54.0",
+    "@oxc-parser/binding-linux-x64-gnu": "0.54.0",
+    "@oxc-parser/binding-linux-arm64-gnu": "0.54.0",
+    "@oxc-parser/binding-linux-x64-musl": "0.54.0",
+    "@oxc-parser/binding-linux-arm64-musl": "0.54.0",
+    "@oxc-parser/binding-darwin-x64": "0.54.0",
+    "@oxc-parser/binding-darwin-arm64": "0.54.0"
   }
 }