isaacscript-lint 1.0.157 → 1.0.160

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 +11 -10
  2. package/package.json +5 -9
package/README.md CHANGED
@@ -26,17 +26,17 @@ Use the `isaacscript init` tool to automatically set up a new mod that has `isaa
26
26
 
27
27
  ## Why Code Formatting is Important
28
28
 
29
- In the 90's, the most popular scripting language in the world was [Perl](https://www.perl.org/), invented by [Larry Wall](https://en.wikipedia.org/wiki/Larry_Wall). One of Larry's slogans was that "There Is Always More Than One Way To Do It", abbreviated as the TIAMTOWTDI principle. In Perl, there were many different ways to do even the most basic thing, like adding an element to an array. This resulted in a Perl ecosystem where programs often looked nothing like each other, where everyone had different coding styles, and where everything was hard to read and comprehend.
29
+ In the 90's, the most popular scripting language in the world was [Perl](https://www.perl.org/), invented by [Larry Wall](https://en.wikipedia.org/wiki/Larry_Wall). One of Larry's slogans was that "There Is Always More Than One Way To Do It", abbreviated as the TIAMTOWTDI principle. In Perl, there were many different ways to do even the most basic thing, like adding an element to an array. This resulted in a Perl ecosystem where programs often looked nothing like each other, where everyone had different coding styles, and where everything was hard to read and comprehend. <!-- cspell:ignore TIAMTOWTDI -->
30
30
 
31
- One of the key insights of [Guido van Rossum](https://en.wikipedia.org/wiki/Guido_van_Rossum), the creator of the [Python](https://www.python.org/) programming language, was that [code is read much more often than it is written](https://www.python.org/dev/peps/pep-0008/). Python was designed to be concise, clean, and readable. It had standard ways of doing things and recommended that everyone follow the [PEP-8 coding standard](https://www.python.org/dev/peps/pep-0008/). And so, in the 90s, there was a massive movement away from Perl and towards Python. Now, Python is the [most popular programming language in the world](https://pypl.github.io/PYPL.html).
31
+ One of the key insights of [Guido van Rossum](https://en.wikipedia.org/wiki/Guido_van_Rossum), the creator of the [Python](https://www.python.org/) programming language, was that [code is read much more often than it is written](https://www.python.org/dev/peps/pep-0008/). Python was designed to be concise, clean, and readable. It had standard ways of doing things and recommended that everyone follow the [PEP-8 coding standard](https://www.python.org/dev/peps/pep-0008/). And so, in the 90s, there was a massive movement away from Perl and towards Python. Now, Python is the [most popular programming language in the world](https://pypl.github.io/PYPL.html). <!-- cspell:ignore Rossum -->
32
32
 
33
- [Go](https://golang.org/), the programming language designed at Google in 2009, took this concept a step further. They included a code formatter inside of the language itself, called `gofmt` (which is short for "Go formatter"). When you are coding a Go program, it will automatically format all of the code as soon as you save the file. This can be surprising and disturbing for newcomers: "Why does `gofmt` make my code ugly?!"
33
+ [Go](https://golang.org/), the programming language designed at Google in 2009, took this concept a step further. They included a code formatter inside of the language itself, called `gofmt` (which is short for "Go formatter"). When you are coding a Go program, it will automatically format all of the code as soon as you save the file. This can be surprising and disturbing for newcomers: "Why does `gofmt` make my code ugly?!" <!-- cspell:ignore gofmt -->
34
34
 
35
35
  However, once people get used to the formatter, they realize that it saves them a _tremendous amount of time_. By ignoring all formatting and typing out code "raw", and then summoning the formatter to instantly fix everything, you can quite literally code twice as fast. Rob Pike, one of the creators of Go, famously said that "gofmt's style is no one's favorite, yet gofmt is everyone's favorite". ([This YouTube clip](https://www.youtube.com/embed/PAAkCSZUG1c?start=523&end=568) of Rob is a much-watch!)
36
36
 
37
37
  `gofmt` is nice because it saves people from mundane code formatting. But there is also a benefit that is entirely separate and not readily apparent. When looking at other people's Go code on StackOverflow or GitHub, you realize that it looks exactly like your code. It's easy to read and comprehend. And you can copy-paste code snippets from other programs into your own applications without having to change anything! For programmers, this is not the norm, and it feels great - it's the hidden superpower of Go.
38
38
 
39
- When Rob says that everyone loves `gofmt`, he isn't lying. Programmers across the world have taken this concept and ran with it. People now use [rustfmt](https://github.com/rust-lang/rustfmt) in [Rust](https://www.rust-lang.org/), [Black](https://github.com/psf/black) in [Python](https://www.python.org/), and [Prettier](https://prettier.io/) in [JavaScript](https://www.javascript.com/) & [TypeScript](https://www.typescriptlang.org/).
39
+ When Rob says that everyone loves `gofmt`, he isn't lying. Programmers across the world have taken this concept and ran with it. People now use [rustfmt](https://github.com/rust-lang/rustfmt) in [Rust](https://www.rust-lang.org/), [Black](https://github.com/psf/black) in [Python](https://www.python.org/), and [Prettier](https://prettier.io/) in [JavaScript](https://www.javascript.com/) & [TypeScript](https://www.typescriptlang.org/). <!-- cspell:ignore rustfmt -->
40
40
 
41
41
  The root of the problem here is that when people try out a new programming language, they often use the same formatting and conventions that they used in their previous language. This fractures the ecosystem and makes everyone's code inconsistent and hard to read. The lesson of Go is that whenever you code in a new language, you should use the standard style that everyone else uses for that language. In this way, every language can have the superpower that Go has.
42
42
 
@@ -105,19 +105,20 @@ module.exports = {
105
105
 
106
106
  Create a `tsconfig.eslint.json` file in the root of your repository:
107
107
 
108
+ <!-- cspell:ignore Gruntfile -->
109
+
108
110
  ```jsonc
109
- // A special TypeScript configuration file, used by ESLint only
111
+ // A special TypeScript configuration file, used by ESLint only.
110
112
  {
111
113
  "extends": "./tsconfig.json",
112
114
 
113
- // A list of the TypeScript files to compile
115
+ // A list of the TypeScript files to compile:
114
116
  "include": [
115
- // This must match the "include" setting in the main "tsconfig.json" file
117
+ // This must match the "include" setting in the main "tsconfig.json" file.
116
118
  "./src/**/*.ts",
117
119
 
118
- // These are ESLint-only inclusions
119
- // Usually, this includes any files that are outside of your "src" directory,
120
- // such as "webpack.config.js", "jest.config.js", "Gruntfile.js", and so forth
120
+ // These are ESLint-only inclusions. Usually, this includes any files that are outside of your
121
+ // "src" directory, such as "webpack.config.js", "jest.config.js", "Gruntfile.js", and so forth.
121
122
  "./.eslintrc.js"
122
123
  ]
123
124
  }
package/package.json CHANGED
@@ -1,19 +1,19 @@
1
1
  {
2
2
  "name": "isaacscript-lint",
3
- "version": "1.0.157",
4
- "description": "An updatable linting dependency container for IsaacScript and TypeScript projects",
3
+ "version": "1.0.160",
4
+ "description": "A linting dependency meta-package for IsaacScript and TypeScript projects.",
5
5
  "repository": {
6
6
  "type": "git",
7
7
  "url": "git+https://github.com/IsaacScript/isaacscript-lint.git"
8
8
  },
9
9
  "license": "MIT",
10
10
  "author": "Zamiell",
11
- "files": [],
11
+ "type": "commonjs",
12
12
  "dependencies": {
13
13
  "@prettier/plugin-xml": "^2.2.0",
14
14
  "@typescript-eslint/eslint-plugin": "^5.25.0",
15
15
  "@typescript-eslint/parser": "^5.25.0",
16
- "cspell": "^5.21.0",
16
+ "cspell": "^5.21.1",
17
17
  "eslint": "^8.15.0",
18
18
  "eslint-config-airbnb-base": "^15.0.0",
19
19
  "eslint-config-airbnb-typescript": "^17.0.0",
@@ -21,18 +21,14 @@
21
21
  "eslint-config-prettier": "^8.5.0",
22
22
  "eslint-plugin-eslint-comments": "^3.2.0",
23
23
  "eslint-plugin-import": "^2.26.0",
24
- "eslint-plugin-isaacscript": "^1.0.43",
24
+ "eslint-plugin-isaacscript": "^1.0.45",
25
25
  "eslint-plugin-jsdoc": "^39.3.0",
26
- "eslint-plugin-no-implicit-map-set-loops": "^1.0.3",
27
26
  "eslint-plugin-only-warn": "^1.0.3",
28
27
  "eslint-plugin-sort-exports": "^0.6.0",
29
28
  "prettier": "^2.6.2",
30
29
  "prettier-plugin-organize-imports": "^2.3.4",
31
30
  "ts-prune": "^0.10.3"
32
31
  },
33
- "devDependencies": {
34
- "npm-check-updates": "^13.0.1"
35
- },
36
32
  "peerDependencies": {
37
33
  "typescript": "^4.6.2"
38
34
  }