typeslayer 0.1.24 → 0.1.26

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +6 -30
  2. package/package.json +4 -4
package/README.md CHANGED
@@ -23,41 +23,17 @@ in the root package you want to inspect (i.e. colocated to your package.json). T
23
23
 
24
24
  ## Frequently Asked Questions
25
25
 
26
- - will this ever get CI support for analysis file generation?
27
- - yeah prolly eventually.
28
- - will this support monorepos?
29
- - that's the hope. one step at a time.
30
- - why isn't this just a CLI tool?
31
- - a goal of the project is show intuitive/beautiful interactive visualizations like treemaps and force graphs, inherently not something a terminal can provide.
32
- - I don't like CLI tools. I view them as a last resort, at this point in engineering history. if you're someone that stays up late into the night staring at your dotfiles from neovim... I'm happy for you. be happy for me too?
33
- - will this work with ts-go?
34
- - that's the hope but it ain't ready yet on the ts-go side
26
+ see: [FAQ](https://github.com/dimitropoulos/typeslayer/blob/main/FAQ.md)
35
27
 
36
- # Who needs this stupid thing, anyway?
28
+ ## Support
37
29
 
38
- TypeSlayer is one of those things that most developers don't need. others might just find it lulzy to play around with.
30
+ TypeSlayer supports Linux x64 (glibc 2.39+), macOS ARM64 (Apple Silicon), and Windows x64. Please note that next year is the year of the Linux desktop 📯.
39
31
 
40
- but then there's the power users. the library authors. the people attending SquiggleConf. you know the kind.
32
+ ## Security
41
33
 
42
- for the people pushing the boundaries of TypeScript (or at companies doing so intentionally or not), a tool like this is something we haven't seen before. there were ways to trash _hours_ messing with multi-hundred-megabyte JSON files. and that's not even counting the time required to learn how the TypeScript compiler works so you can understand the problem... it's a lot.
34
+ TypeSlayer currently does not collect any analytics - although it probably will try to collect "someone somewhere ran it at XYZ timestamp" data in the future (or possibly crashlytics). If that day comes, of course you'll be able to opt out (including before app boot via config).
43
35
 
44
- consider the fact that this can sometimes feel like an impossible task for a library author because the code that actually exercises the library isn't directly accessible - it's in the _library user_'s code (which is usually private).
45
-
46
- I made TypeSlayer because I learned delulu-levels-of-detail about TypeScript performance tuning [while getting Doom to run in TypeScript types](https://youtu.be/0mCsluv5FXA), yet many of those techniques are still opaque to most people.
47
-
48
- I wanted to make it easy for others to put up PRs at their companies all like "I increased type-checking perf on this file by 380,000x and shaved 23 seconds off every CI run" (real story btw lol). I took what I learned about how to debug type performance and wrapped it all up into this tool.
49
-
50
- ## Data / Security
51
-
52
- TypeSlayer supports Linux x64 (glibc 2.39+), macOS ARM64 (Apple Silicon), and Windows x64. Please note that next year is the year of the Linux desktop.
53
-
54
- TypeSlayer currently does not collect any analytics - although it probably will try to collect "someone somewhere ran it at XYZ timestamp" data in the future. all data is stored:
55
-
56
- - Linux: `~/.local/share/typeslayer/`
57
- - macOS: `~/Library/Application Support/typeslayer/`
58
- - Windows: `%APPDATA%\typeslayer\`
59
-
60
- TypeSlayer can read any file the running user can read and it can run package.json scripts (so treat it as you would your terminal).
36
+ Actually TypeSlayer is a fully offline app - it does not make any network requests.
61
37
 
62
38
  ## Contributing
63
39
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "typeslayer",
3
- "version": "0.1.24",
3
+ "version": "0.1.26",
4
4
  "description": "Slay your TypeScript types",
5
5
  "private": false,
6
6
  "type": "module",
@@ -43,8 +43,8 @@
43
43
  "postinstall": "node scripts/postinstall.js"
44
44
  },
45
45
  "optionalDependencies": {
46
- "@typeslayer/linux-x64": "0.1.24",
47
- "@typeslayer/darwin-arm64": "0.1.24",
48
- "@typeslayer/win32-x64": "0.1.24"
46
+ "@typeslayer/linux-x64": "0.1.26",
47
+ "@typeslayer/darwin-arm64": "0.1.26",
48
+ "@typeslayer/win32-x64": "0.1.26"
49
49
  }
50
50
  }