Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ export default {

- **Check that prettier formats code on commit:** Only fix the eslint errors shown in your terminal, leave any other inconsistent formatting. Add and commit your `.ts` file to git. You should see that the code in the file(s) commited to git has been formatted properly by `prettier`, and the commit is also successful.

- **Eslint + typescript intellisense:** Additinally, you should already be able to see `eslint` + `typescript` intellisense working in your code editor i.e. red and yellow wiggly lines in the new `.ts` file - that is `eslint` notifying you about the code quality-related errors and warnings present in the code. If the intellisense isn't showing for you, see the **troubleshooting** section at the end of this installation guide.
- **Eslint + typescript intellisense:** Additionally, you should already be able to see `eslint` + `typescript` intellisense working in your code editor i.e. red and yellow wiggly lines in the new `.ts` file - that is `eslint` notifying you about the code quality-related errors and warnings present in the code. If the intellisense isn't showing for you, see the **troubleshooting** section at the end of this installation guide.


#### 7. Running Eslint and prettier manually without husky
Expand Down Expand Up @@ -250,7 +250,8 @@ Make sure to add and commit all your setup files to git, and push/merge it to yo

#### 10. Troubleshooting

**Eslint + typescript intellisense:** If the `eslint` + `typescript` intellisense is not showing red and yellow wiggly lines in your code file, first check that you have `eslint` extension installed in your code editor (that is, if you are using VScode). If you have the extension and it still doesn't show up, closing and reopening your code editor (or just the file you are editing) may fix it.
- **Eslint + typescript intellisense -** If the `eslint` + `typescript` intellisense is not showing red and yellow wiggly lines in your code file, first check that you have `eslint` extension installed in your code editor (that is, if you are using VScode). If you have the extension and it still doesn't show up, closing and reopening your code editor (or just the file you are editing) may fix it.
- **Git hooks not working on commit?** For example, if you have unused variable(s) in a code file that you've added to git, the expectation is that `husky` will prevent committing the file to git. If it happens that it doesn't pass this basic expectation, there's a problem. Upgrade your code editor (if new updates are available), and restart your code editor. Next, run the `npm run prepare` command again, then attempt to commit the file to git.

#

Expand Down
4 changes: 2 additions & 2 deletions docs.users/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

# User guide: @build-in-blocks/dev.setup package installation, setup and usage
# User guide: Package installation, setup and usage

**@build-in-blocks/dev.setup** provides TS development environment setup and comes with preconfigured settings. It helps to automate code compatibilty, quality and formatting checks within your typescript code repository's Git workflow, ensuring that only clean, consistent code is committed to the repository. It also includes GitHub Actions Continuous Integration (CI) setup for running these checks on the contributions submitted to your repository, by your open source contributors or work colleagues. Of course, you can configure it to use your preferred settings too.

Expand Down Expand Up @@ -137,7 +137,7 @@ export default defineConfig([

#### 2. Updating Prettier settings

You can find more detailed guidance in `prettier` documentation. Here's an example of how to make your project use `tabs` with indent of `4`, instead of our "use spaces with index of 2" default:
You can find more detailed guidance in `prettier` documentation. Here's an example of how to make your project use `tabs` with indent of `4`, instead of our "use spaces with indent of `2`" default:

````
import basePrettier from '@build-in-blocks/dev.setup/prettier';
Expand Down
Loading