Skip to content

Commit 82324bb

Browse files
committed
Update readme and prepare release
1 parent 4b3205f commit 82324bb

File tree

3 files changed

+31
-6
lines changed

3 files changed

+31
-6
lines changed

README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,20 +13,19 @@ and map them with the source map to the original files.
1313

1414
## Usage
1515
### SourceMaps
16-
To parse a sourcemap located at `./app.js.map`
16+
To parse a sourcemap
1717

1818
```csharp
1919
using SourceMaps
2020
// ...
2121
22-
var map = File.ReadAllText("./app.js.map");
23-
var sourceMap = SourceMapParser.Parse(map);
22+
var sourceMap = SourceMapParser.Parse(sourceMapAsString);
2423
```
2524

26-
To get the original mapping for a generated position, use
25+
To get the original mapping for a given generated position, use
2726

2827
```csharp
29-
var mapping = sourceMap.OriginalPositionFor(/* generatedLineNumber */ 1, /* generatedColumnNumber */ 1);
28+
var mapping = sourceMap.OriginalPositionFor(generatedLineNumber: 1, generatedColumnNumber: 1);
3029

3130
mapping.OriginalName; // original token name
3231
mapping.OriginalFileName; // original file name
@@ -38,5 +37,11 @@ mapping.OriginalSourcePosition.ColumnNumber; // original column number
3837
To get the original stack trace using the source maps
3938

4039
```csharp
41-
StackTraceParser.ReTrace(sourceMap, /* JavaScript StackTrace */ "...", /* optional source root */ "https://localhost:5001/js/")
40+
StackTraceParser.ReTrace(
41+
sourceMap,
42+
stackTrace: @"ReferenceError: ""getExceptionProps"" is undefined
43+
at eval code (eval code:1:1)
44+
at foo (http://path/to/file.js:58:17)
45+
at bar (http://path/to/file.js:109:1)",
46+
sourceRoot: "https://localhost:5001/js/");
4247
```

SourceMaps.StackTraces/SourceMaps.StackTraces.csproj

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,16 @@
22

33
<PropertyGroup>
44
<TargetFramework>netstandard2.0</TargetFramework>
5+
6+
<PackageId>SourceMaps.StackTraces</PackageId>
7+
<Version>0.1.0</Version>
8+
<Authors>sleeuwen</Authors>
9+
<Description>.NET Standard 2.0 library for parsing javascript stacktraces and mapping them to sourcemaps</Description>
10+
<PackageDescription>.NET Standard 2.0 library for parsing javascript stacktraces and mapping them to sourcemaps</PackageDescription>
11+
<RepositoryUrl>https://github.com/sleeuwen/sourcemaps</RepositoryUrl>
12+
<PackageLicenseExpression>MIT</PackageLicenseExpression>
13+
<Title>SourceMaps.StackTraces</Title>
14+
<PackageTags>source-map;javascript-stacktrace</PackageTags>
515
</PropertyGroup>
616

717
<ItemGroup>

SourceMaps/SourceMaps.csproj

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,16 @@
33
<PropertyGroup>
44
<TargetFramework>netstandard2.0</TargetFramework>
55
<LangVersion>8.0</LangVersion>
6+
7+
<PackageId>SourceMaps</PackageId>
8+
<Version>0.1.0</Version>
9+
<Authors>sleeuwen</Authors>
10+
<Description>.NET Standard 2.0 library for parsing sourcemaps</Description>
11+
<PackageDescription>.NET Standard 2.0 library for parsing sourcemaps</PackageDescription>
12+
<RepositoryUrl>https://github.com/sleeuwen/sourcemaps</RepositoryUrl>
13+
<PackageLicenseExpression>MIT</PackageLicenseExpression>
14+
<Title>SourceMaps</Title>
15+
<PackageTags>source-map</PackageTags>
616
</PropertyGroup>
717

818
<ItemGroup>

0 commit comments

Comments
 (0)