jupyterlab-makefile-file-type-extension 1.0.6__tar.gz

jupyterlab_makefile_file_type_extension-1.0.6/.claude/CLAUDE.md

@@ -0,0 +1 @@
+- when committing to git make sure we have updated and committed package.json and lock files

jupyterlab_makefile_file_type_extension-1.0.6/.claude/JOURNAL.md

@@ -0,0 +1,29 @@
+# Claude Code Journal
+
+This journal tracks substantive work on documents, diagrams, and documentation content.
+
+---
+
+1. **Task - Custom Makefile Syntax Highlighter**: Implemented custom CodeMirror language mode for Makefile syntax highlighting<br>
+    **Result**: Created `src/makefile-mode.ts` with comprehensive token recognition for targets, variable assignments, recipe lines, shell commands, and variable references. Replaced generic CMake mode with Makefile-specific parser that properly handles Make syntax constructs.
+
+2. **Task - Variable Reference Coloring**: Implemented distinct styling for different variable reference types<br>
+    **Result**: Make-style variables `$(VAR)` highlighted with strong emphasis, shell-style variables `${VAR}` highlighted as special, automatic variables `$@`, `$<`, etc. highlighted distinctly. Added recognition for Make functions like `$(shell ...)`, `$(wildcard ...)`, `$(patsubst ...)`.
+
+3. **Task - String Parsing Priority**: Fixed string handling to parse quoted text correctly before other tokens<br>
+    **Result**: Moved string detection to top of token parser flow, ensuring single and double quoted strings are properly recognized and highlighted throughout Makefile content including in variable assignments and recipe commands.
+
+4. **Task - Line Continuation Highlighting**: Added distinct highlighting for backslash line continuations<br>
+    **Result**: Implemented detection of backslash at end of line with `keyword.control escape` styling. Regular backslashes in middle of text remain unstyled, ensuring only true line continuations stand out visually.
+
+5. **Task - Custom File Type Icon**: Designed and implemented pale red settings/gear icon for Makefile files<br>
+    **Result**: Created SVG settings icon with pale red color (#ef9a9a) to represent build/make files. Added pattern field to file type registration to match `Makefile`, `makefile`, `GNUmakefile` filenames. Icon displays in JupyterLab file browser.
+
+6. **Task - Makefile Upgrade Target**: Extended project Makefile with upgrade target for dependency management<br>
+    **Result**: Added `upgrade` target dependent on `check_dependencies` that executes `npm update`, `yarn install`, and `yarn upgrade`. Updated `.PHONY` declarations and bumped Makefile version to 1.25.
+
+7. **Task - Icon Refinement to VS Code Style**: Replaced settings gear icon with bold capital M letter matching VS Code design<br>
+    **Result**: Implemented SVG text-based icon featuring bold (font-weight 900) capital letter "M" in pale red color. Initial color #ef9a9a adjusted to slightly redder #e57373 for better visibility and brand consistency with VS Code Makefile icon style.
+
+8. **Task - Icon Color Optimization**: Fine-tuned M icon color for improved visibility and aesthetic appeal<br>
+    **Result**: Progressively refined icon color from #e57373 to darker and more saturated #d84a4a, achieving better contrast and visual prominence in JupyterLab file browser while maintaining the recognizable red color scheme associated with Makefile icons. Version bumped to 1.0.2 to mark stable release.

jupyterlab_makefile_file_type_extension-1.0.6/.claude/settings.local.json

@@ -0,0 +1,21 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(npm run build:lib:prod:*)",
+      "Bash(yarn install)",
+      "Bash(git add:*)",
+      "Bash(cat:*)",
+      "Bash(git commit:*)",
+      "Bash(git push)",
+      "Bash(curl:*)",
+      "Bash(git rebase:*)",
+      "Bash(git stash:*)",
+      "Bash(GIT_SEQUENCE_EDITOR=\"sed -i ''1s/^pick/reword/''\" git rebase -i --root)",
+      "Bash(git filter-branch:*)",
+      "Bash(git push:*)",
+      "Bash(git tag:*)"
+    ],
+    "deny": [],
+    "ask": []
+  }
+}

jupyterlab_makefile_file_type_extension-1.0.6/.copier-answers.yml

@@ -0,0 +1,16 @@
+# Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
+_commit: v4.5.0
+_src_path: https://github.com/jupyterlab/extension-template
+author_email: konrad.jelen@gmail.com
+author_name: Stellars Henson
+has_ai_rules: false
+has_binder: false
+has_settings: false
+kind: frontend
+labextension_name: jupyterlab_makefile_file_type_extension
+project_short_description: Jupyterlab extension to add handling of Makefiles and syntax
+    colouring support
+python_name: jupyterlab_makefile_file_type_extension
+repository: ''
+test: true
+

jupyterlab_makefile_file_type_extension-1.0.6/.git

@@ -0,0 +1 @@
+gitdir: ../../../.git/modules/private/jupyterlab/jupyterlab_makefile_file_type_extension

jupyterlab_makefile_file_type_extension-1.0.6/.gitignore

@@ -0,0 +1,128 @@
+*.bundle.*
+lib/
+node_modules/
+*.log
+.eslintcache
+.stylelintcache
+*.egg-info/
+.ipynb_checkpoints
+*.tsbuildinfo
+jupyterlab_makefile_file_type_extension/labextension
+# Version file is handled by hatchling
+jupyterlab_makefile_file_type_extension/_version.py
+
+# Integration tests
+ui-tests/test-results/
+ui-tests/playwright-report/
+
+# Created by https://www.gitignore.io/api/python
+# Edit at https://www.gitignore.io/?templates=python
+
+### Python ###
+# Virtual environments
+.venv
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage/
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# Mr Developer
+.mr.developer.cfg
+.project
+.pydevproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# End of https://www.gitignore.io/api/python
+
+# OSX files
+.DS_Store
+
+# Yarn cache
+.yarn/

jupyterlab_makefile_file_type_extension-1.0.6/.prettierignore

@@ -0,0 +1,6 @@
+node_modules
+**/node_modules
+**/lib
+**/package.json
+!/package.json
+jupyterlab_makefile_file_type_extension

jupyterlab_makefile_file_type_extension-1.0.6/.yarnrc.yml

@@ -0,0 +1 @@
+nodeLinker: node-modules

jupyterlab_makefile_file_type_extension-1.0.6/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+<!-- <START NEW CHANGELOG ENTRY> -->
+
+<!-- <END NEW CHANGELOG ENTRY> -->

jupyterlab_makefile_file_type_extension-1.0.6/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2025, Stellars Henson
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

jupyterlab_makefile_file_type_extension-1.0.6/Makefile

@@ -0,0 +1,120 @@
+# Makefile for Jupyterlab extensions version 1.25
+# author: Stellars Henson <konrad.jelen@gmail.com
+# License: MIT Open Source License
+
+.PHONY: build install clean uninstall publish dependencies mrproper increment_version install_dependencies check_dependencies upgrade help
+.DEFAULT_GOAL := help
+
+# Read current version from package.json (only if node is available)
+VERSION := $(shell command -v node >/dev/null 2>&1 && node -p "require('./package.json').version" || echo "0.0.0")
+
+## increment project version
+increment_version:
+	@echo "Current version: $(VERSION)"
+	@bash -c 'CURRENT_VERSION=$(VERSION); \
+	IFS="." read -r major minor patch <<< "$$CURRENT_VERSION"; \
+	NEW_PATCH=$$((patch + 1)); \
+	NEW_VERSION="$$major.$$minor.$$NEW_PATCH"; \
+	echo "New version: $$NEW_VERSION"; \
+	sed -i "s/\"version\": \"$$CURRENT_VERSION\"/\"version\": \"$$NEW_VERSION\"/" package.json; '
+
+## build packages
+build: clean increment_version check_dependencies
+	npm install
+	yarn install
+	python -m build 
+
+## install package
+install: build 
+	pip install dist/*.whl --force-reinstall
+
+## clean builds and installables
+clean: uninstall  check_dependencies
+	@command -v npm >/dev/null 2>&1 && npm run clean || true
+	@command -v npm >/dev/null 2>&1 && npm run clean:labextension || true
+	rm -rf dist lib || true
+
+## uninstall package
+uninstall:  check_dependencies
+	pip uninstall -y dist/*.whl 2>/dev/null || true
+
+## check if required dependencies are installed
+check_dependencies:
+	@echo "Checking dependencies..."
+	@MISSING=""; \
+	command -v node >/dev/null 2>&1 || MISSING="$$MISSING node"; \
+	command -v npm >/dev/null 2>&1 || MISSING="$$MISSING npm"; \
+	command -v yarn >/dev/null 2>&1 || MISSING="$$MISSING yarn"; \
+	command -v twine >/dev/null 2>&1 || MISSING="$$MISSING twine"; \
+	if [ -n "$$MISSING" ]; then \
+		echo "Missing dependencies:$$MISSING"; \
+		echo "Installing missing dependencies..."; \
+		$(MAKE) install_dependencies; \
+	else \
+		echo "All dependencies are installed."; \
+	fi
+
+## publish package to public repository
+publish: check_dependencies install
+	npm publish --access public
+	twine upload dist/*
+
+## install all required build dependencies
+install_dependencies:
+	conda install -y nodejs yarn --update-all
+	pip install twine
+	npm install rimraf
+
+## upgrade all npm and yarn dependencies
+upgrade: check_dependencies
+	npm update
+	yarn install
+	yarn upgrade
+
+## cleanup all build and metabuild artefacts
+mrproper: clean uninstall
+	rm -rf node_modules .yarn || true
+
+## prints the list of available commands
+help:
+	@echo ""
+	@echo "$$(tput bold)Available rules:$$(tput sgr0)"
+	@sed -n -e "/^## / { \
+		h; \
+		s/.*//; \
+		:doc" \
+		-e "H; \
+		n; \
+		s/^## //; \
+		t doc" \
+		-e "s/:.*//; \
+		G; \
+		s/\\n## /---/; \
+		s/\\n/ /g; \
+		p; \
+	}" ${MAKEFILE_LIST} \
+	| LC_ALL='C' sort --ignore-case \
+	| awk -F '---' \
+		-v ncol=$$(tput cols) \
+		-v indent=19 \
+		-v col_on="$$(tput setaf 6)" \
+		-v col_off="$$(tput sgr0)" \
+	'{ \
+		printf "%s%*s%s ", col_on, -indent, $$1, col_off; \
+		n = split($$2, words, " "); \
+		line_length = ncol - indent; \
+		for (i = 1; i <= n; i++) { \
+			line_length -= length(words[i]) + 1; \
+			if (line_length <= 0) { \
+				line_length = ncol - indent - length(words[i]) - 1; \
+				printf "\n%*s ", -indent, " "; \
+			} \
+			printf "%s ", words[i]; \
+		} \
+		printf "\n"; \
+	}' 
+	@echo ""
+
+
+# EOF
+

jupyterlab_makefile_file_type_extension-1.0.6/PKG-INFO

@@ -0,0 +1,180 @@
+Metadata-Version: 2.4
+Name: jupyterlab_makefile_file_type_extension
+Version: 1.0.6
+Summary: Jupyterlab extension to add handling of Makefiles and syntax colouring support
+Project-URL: Homepage, https://github.com/stellarshenson/jupyterlab_makefile_file_type_extension
+Project-URL: Bug Tracker, https://github.com/stellarshenson/jupyterlab_makefile_file_type_extension/issues
+Project-URL: Repository, https://github.com/stellarshenson/jupyterlab_makefile_file_type_extension.git
+Author-email: Stellars Henson <konrad.jelen@gmail.com>
+License: BSD 3-Clause License
+        
+        Copyright (c) 2025, Stellars Henson
+        All rights reserved.
+        
+        Redistribution and use in source and binary forms, with or without
+        modification, are permitted provided that the following conditions are met:
+        
+        1. Redistributions of source code must retain the above copyright notice, this
+           list of conditions and the following disclaimer.
+        
+        2. Redistributions in binary form must reproduce the above copyright notice,
+           this list of conditions and the following disclaimer in the documentation
+           and/or other materials provided with the distribution.
+        
+        3. Neither the name of the copyright holder nor the names of its
+           contributors may be used to endorse or promote products derived from
+           this software without specific prior written permission.
+        
+        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+License-File: LICENSE
+Keywords: jupyter,jupyterlab,jupyterlab-extension
+Classifier: Framework :: Jupyter
+Classifier: Framework :: Jupyter :: JupyterLab
+Classifier: Framework :: Jupyter :: JupyterLab :: 4
+Classifier: Framework :: Jupyter :: JupyterLab :: Extensions
+Classifier: Framework :: Jupyter :: JupyterLab :: Extensions :: Prebuilt
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+
+# jupyterlab_makefile_file_type_extension
+
+[![GitHub Actions](https://github.com/stellarshenson/jupyterlab_makefile_file_type_extension/actions/workflows/build.yml/badge.svg)](https://github.com/stellarshenson/jupyterlab_makefile_file_type_extension/actions/workflows/build.yml)
+[![npm version](https://img.shields.io/npm/v/jupyterlab_makefile_file_type_extension.svg)](https://www.npmjs.com/package/jupyterlab_makefile_file_type_extension)
+[![PyPI version](https://img.shields.io/pypi/v/jupyterlab-makefile-file-type-extension.svg)](https://pypi.org/project/jupyterlab-makefile-file-type-extension/)
+[![Total PyPI downloads](https://static.pepy.tech/badge/jupyterlab-makefile-file-type-extension)](https://pepy.tech/project/jupyterlab-makefile-file-type-extension)
+[![JupyterLab 4](https://img.shields.io/badge/JupyterLab-4-orange.svg)](https://jupyterlab.readthedocs.io/en/stable/)
+
+A JupyterLab extension providing comprehensive Makefile support with syntax highlighting and custom file type recognition.
+
+![Makefile Extension Screenshot](.resources/screenshot.png)
+
+## Features
+
+This extension enhances the Makefile editing experience in JupyterLab with intelligent syntax highlighting and visual aids:
+
+- **Custom syntax highlighter** - Purpose-built CodeMirror language mode for accurate Makefile token recognition
+- **Target highlighting** - Build targets (`build:`, `install:`, etc.) displayed in bold with distinct keyword styling
+- **Variable recognition** - Make-style `$(VAR)` and shell-style `${VAR}` variables colored differently for clarity
+- **Automatic variables** - Special variables like `$@`, `$<`, `$^` highlighted distinctly
+- **Function support** - Make functions (`$(shell ...)`, `$(wildcard ...)`, etc.) recognized as keywords
+- **Line continuations** - Backslash line breaks (`\`) at end of lines highlighted prominently
+- **String parsing** - Quoted strings in single and double quotes properly recognized throughout
+- **Recipe detection** - Tab-indented command lines distinguished from regular Makefile content
+- **Custom icon** - VS Code-style bold red "M" icon for easy Makefile identification in file browser
+- **Pattern matching** - Recognizes `Makefile`, `makefile`, `GNUmakefile`, and `*.mk` files
+
+## Requirements
+
+- JupyterLab >= 4.0.0
+
+## Install
+
+To install the extension, execute:
+
+```bash
+pip install jupyterlab_makefile_file_type_extension
+```
+
+## Uninstall
+
+To remove the extension, execute:
+
+```bash
+pip uninstall jupyterlab_makefile_file_type_extension
+```
+
+## Contributing
+
+### Development install
+
+Note: You will need NodeJS to build the extension package.
+
+The `jlpm` command is JupyterLab's pinned version of
+[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
+`yarn` or `npm` in lieu of `jlpm` below.
+
+```bash
+# Clone the repo to your local environment
+# Change directory to the jupyterlab_makefile_file_type_extension directory
+
+# Set up a virtual environment and install package in development mode
+python -m venv .venv
+source .venv/bin/activate
+pip install --editable "."
+
+# Link your development version of the extension with JupyterLab
+jupyter labextension develop . --overwrite
+
+# Rebuild extension Typescript source after making changes
+# IMPORTANT: Unlike the steps above which are performed only once, do this step
+# every time you make a change.
+jlpm build
+```
+
+You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.
+
+```bash
+# Watch the source directory in one terminal, automatically rebuilding when needed
+jlpm watch
+# Run JupyterLab in another terminal
+jupyter lab
+```
+
+With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).
+
+By default, the `jlpm build` command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:
+
+```bash
+jupyter lab build --minimize=False
+```
+
+### Development uninstall
+
+```bash
+pip uninstall jupyterlab_makefile_file_type_extension
+```
+
+In development mode, you will also need to remove the symlink created by `jupyter labextension develop`
+command. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions`
+folder is located. Then you can remove the symlink named `jupyterlab_makefile_file_type_extension` within that folder.
+
+### Testing the extension
+
+#### Frontend tests
+
+This extension is using [Jest](https://jestjs.io/) for JavaScript code testing.
+
+To execute them, execute:
+
+```sh
+jlpm
+jlpm test
+```
+
+#### Integration tests
+
+This extension uses [Playwright](https://playwright.dev/docs/intro) for the integration tests (aka user level tests).
+More precisely, the JupyterLab helper [Galata](https://github.com/jupyterlab/jupyterlab/tree/master/galata) is used to handle testing the extension in JupyterLab.
+
+More information are provided within the [ui-tests](./ui-tests/README.md) README.
+
+### Packaging the extension
+
+See [RELEASE](RELEASE.md)

jupyterlab_makefile_file_type_extension-1.0.6/README.md

@@ -0,0 +1,125 @@
+# jupyterlab_makefile_file_type_extension
+
+[![GitHub Actions](https://github.com/stellarshenson/jupyterlab_makefile_file_type_extension/actions/workflows/build.yml/badge.svg)](https://github.com/stellarshenson/jupyterlab_makefile_file_type_extension/actions/workflows/build.yml)
+[![npm version](https://img.shields.io/npm/v/jupyterlab_makefile_file_type_extension.svg)](https://www.npmjs.com/package/jupyterlab_makefile_file_type_extension)
+[![PyPI version](https://img.shields.io/pypi/v/jupyterlab-makefile-file-type-extension.svg)](https://pypi.org/project/jupyterlab-makefile-file-type-extension/)
+[![Total PyPI downloads](https://static.pepy.tech/badge/jupyterlab-makefile-file-type-extension)](https://pepy.tech/project/jupyterlab-makefile-file-type-extension)
+[![JupyterLab 4](https://img.shields.io/badge/JupyterLab-4-orange.svg)](https://jupyterlab.readthedocs.io/en/stable/)
+
+A JupyterLab extension providing comprehensive Makefile support with syntax highlighting and custom file type recognition.
+
+![Makefile Extension Screenshot](.resources/screenshot.png)
+
+## Features
+
+This extension enhances the Makefile editing experience in JupyterLab with intelligent syntax highlighting and visual aids:
+
+- **Custom syntax highlighter** - Purpose-built CodeMirror language mode for accurate Makefile token recognition
+- **Target highlighting** - Build targets (`build:`, `install:`, etc.) displayed in bold with distinct keyword styling
+- **Variable recognition** - Make-style `$(VAR)` and shell-style `${VAR}` variables colored differently for clarity
+- **Automatic variables** - Special variables like `$@`, `$<`, `$^` highlighted distinctly
+- **Function support** - Make functions (`$(shell ...)`, `$(wildcard ...)`, etc.) recognized as keywords
+- **Line continuations** - Backslash line breaks (`\`) at end of lines highlighted prominently
+- **String parsing** - Quoted strings in single and double quotes properly recognized throughout
+- **Recipe detection** - Tab-indented command lines distinguished from regular Makefile content
+- **Custom icon** - VS Code-style bold red "M" icon for easy Makefile identification in file browser
+- **Pattern matching** - Recognizes `Makefile`, `makefile`, `GNUmakefile`, and `*.mk` files
+
+## Requirements
+
+- JupyterLab >= 4.0.0
+
+## Install
+
+To install the extension, execute:
+
+```bash
+pip install jupyterlab_makefile_file_type_extension
+```
+
+## Uninstall
+
+To remove the extension, execute:
+
+```bash
+pip uninstall jupyterlab_makefile_file_type_extension
+```
+
+## Contributing
+
+### Development install
+
+Note: You will need NodeJS to build the extension package.
+
+The `jlpm` command is JupyterLab's pinned version of
+[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
+`yarn` or `npm` in lieu of `jlpm` below.
+
+```bash
+# Clone the repo to your local environment
+# Change directory to the jupyterlab_makefile_file_type_extension directory
+
+# Set up a virtual environment and install package in development mode
+python -m venv .venv
+source .venv/bin/activate
+pip install --editable "."
+
+# Link your development version of the extension with JupyterLab
+jupyter labextension develop . --overwrite
+
+# Rebuild extension Typescript source after making changes
+# IMPORTANT: Unlike the steps above which are performed only once, do this step
+# every time you make a change.
+jlpm build
+```
+
+You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.
+
+```bash
+# Watch the source directory in one terminal, automatically rebuilding when needed
+jlpm watch
+# Run JupyterLab in another terminal
+jupyter lab
+```
+
+With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).
+
+By default, the `jlpm build` command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:
+
+```bash
+jupyter lab build --minimize=False
+```
+
+### Development uninstall
+
+```bash
+pip uninstall jupyterlab_makefile_file_type_extension
+```
+
+In development mode, you will also need to remove the symlink created by `jupyter labextension develop`
+command. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions`
+folder is located. Then you can remove the symlink named `jupyterlab_makefile_file_type_extension` within that folder.
+
+### Testing the extension
+
+#### Frontend tests
+
+This extension is using [Jest](https://jestjs.io/) for JavaScript code testing.
+
+To execute them, execute:
+
+```sh
+jlpm
+jlpm test
+```
+
+#### Integration tests
+
+This extension uses [Playwright](https://playwright.dev/docs/intro) for the integration tests (aka user level tests).
+More precisely, the JupyterLab helper [Galata](https://github.com/jupyterlab/jupyterlab/tree/master/galata) is used to handle testing the extension in JupyterLab.
+
+More information are provided within the [ui-tests](./ui-tests/README.md) README.
+
+### Packaging the extension
+
+See [RELEASE](RELEASE.md)