oxc-parser 0.54.0 → 0.56.0

package/README.md

@@ -2,6 +2,26 @@
 
 ## Features
 
+### ESTree
+
+The returned JavaScript AST follows the [ESTree](https://github.com/estree/estree) specification.
+
+It is fully aligned with Acorn's AST, and any deviation would be considered a bug.
+
+The returned TypeScript AST will conform to (`@typescript-eslint/typescript-estree`)[https://www.npmjs.com/package/@typescript-eslint/typescript-estree] in the near future.
+
+### AST Types
+
+[@oxc-project/types](https://www.npmjs.com/package/@oxc-project/types) can be used. For example:
+
+```typescript
+import { Statement } from '@oxc-project/types';
+```
+
+### Visitor
+
+[oxc-walker](https://www.npmjs.com/package/oxc-walker) or [estree-walker](https://www.npmjs.com/package/estree-walker) can be used.
+
 ### Fast Mode
 
 By default, Oxc parser does not produce semantic errors where symbols and scopes are needed.
@@ -17,7 +37,20 @@ 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.
+Fast mode is best suited for parser plugins, where other parts of your build pipeline has already checked for errors.
+
+Please note that turning off fast mode ​incurs​ a small performance overhead.
+
+### ESTree compatibility
+
+When parsing JS or JSX files, the AST returned is fully conformant with the
+[ESTree standard](https://github.com/estree/estree).
+
+When parsing TS or TSX files, the AST has additional properties related to TypeScript syntax.
+These extra properties are broadly (but not entirely) in line with
+[TypeScript ESLint](https://typescript-eslint.io/packages/parser/)'s AST.
+
+If you need all ASTs in the same with-TS-properties format, use the `astType: 'ts'` option.
 
 ### Returns ESM information.
 
@@ -52,7 +85,7 @@ export interface EcmaScriptModule {
 ## API
 
 ```javascript
-import oxc from './index.js';
+import oxc from 'oxc-parser';
 
 const code = 'const url: String = /* 🤨 */ import.meta.url;';
 

package/bindings.js

@@ -374,7 +374,10 @@ module.exports.ParseResult = nativeBinding.ParseResult
 module.exports.ExportExportNameKind = nativeBinding.ExportExportNameKind
 module.exports.ExportImportNameKind = nativeBinding.ExportImportNameKind
 module.exports.ExportLocalNameKind = nativeBinding.ExportLocalNameKind
+module.exports.getBufferOffset = nativeBinding.getBufferOffset
 module.exports.ImportNameKind = nativeBinding.ImportNameKind
 module.exports.parseAsync = nativeBinding.parseAsync
 module.exports.parseSync = nativeBinding.parseSync
+module.exports.parseSyncRaw = nativeBinding.parseSyncRaw
+module.exports.rawTransferSupported = nativeBinding.rawTransferSupported
 module.exports.Severity = nativeBinding.Severity